diff --git a/.github/workflows/mkdocs_ci.yml b/.github/workflows/mkdocs_ci.yml index f90f00c..58757a5 100644 --- a/.github/workflows/mkdocs_ci.yml +++ b/.github/workflows/mkdocs_ci.yml @@ -1,4 +1,4 @@ -name: MkDocs +name: Deploy Docs on: push: branches: @@ -11,5 +11,5 @@ jobs: - uses: actions/setup-python@v2 with: python-version: 3.x - - run: pip install -r docs/requirements.txt + - run: cp README.md docs/index.md && pip install -r docs/requirements.txt - run: mkdocs gh-deploy --force diff --git a/docs/index.md b/docs/index.md index 5cbb5b1..6681679 100644 --- a/docs/index.md +++ b/docs/index.md @@ -3,11 +3,8 @@ Machine Learning Serving focused on GenAI & LLMs with simplicity as the top priority. ## Installation - -```bash -git clone https://github.com/aniketmaurya/fastserve.git -cd fastserve -pip install . +```shell +pip install git+https://github.com/aniketmaurya/fastserve.git@main ``` ## Run locally @@ -63,11 +60,24 @@ app = MyModelServing() app.run_server() ``` -You can run the above script in terminal and it will launch a FastAPI server for your custom model. +You can run the above script in terminal, and it will launch a FastAPI server for your custom model. + + +## Contribute - +**Make your changes, commit and [create a PR](https://github.com/aniketmaurya/fastserve/compare).** \ No newline at end of file +Answer 2 --> diff --git a/src/fastserve/__init__.py b/src/fastserve/__init__.py index 717856b..371cced 100644 --- a/src/fastserve/__init__.py +++ b/src/fastserve/__init__.py @@ -1,4 +1,5 @@ -"""Machine Learning Serving focused on GenAI & LLMs with simplicity as the top priority.""" +"""Machine Learning Serving focused on GenAI & +LLMs with simplicity as the top priority.""" from fastserve.core import FastServe as FastServe __version__ = "0.0.2"