From abca241480600915d994b8831db0f6913a72ed89 Mon Sep 17 00:00:00 2001 From: UdAyAn123 <45636609+UdAyAn123@users.noreply.github.com> Date: Thu, 1 Feb 2024 22:46:58 +0530 Subject: [PATCH] Update README.md --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 42 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f0d51cd..5436740 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,42 @@ -# dalgo-ai -Standalone service for AI +# FastAPI Machine Learning API + +## Overview + +This service exposes an API for various machine-learning tasks, designed to be called by the Dalgo backend. + +## Installation and Setup + +### Prerequisites + +- Python 3.6 or higher +- Pip (Python package installer) + +### Clone the Repository + +```bash +git clone +cd +``` +### Create and Activate Virtual Environment +```bash + python -m venv venv +``` + +#### On Windows: +```bash + .\venv\Scripts\activate +``` +#### On Linux/Mac: +```bash + source venv/bin/activate +``` +### Install Dependencies +```bash + pip install -r requirements.txt +``` +### Run the Application +```bash + uvicorn main:app --reload +``` +> The FastAPI application will be accessible at http://127.0.0.1:8000. +