diff --git a/docs/deployment/fly_io.mdx b/docs/deployment/fly_io.mdx index 73f532af..4cd5e1a3 100644 --- a/docs/deployment/fly_io.mdx +++ b/docs/deployment/fly_io.mdx @@ -40,7 +40,11 @@ In case you run into issues, refer to official [fly.io docs](https://fly.io/docs ## Step-2: Create RAG app -We provide a command line utility called `ec` that inherits the template for `fly.io` platform and help you deploy the app. Follow the instructions to create a fly.io app using the template provided: +We provide a command line utility called `ec` in embedchain that inherits the template for `fly.io` platform and help you deploy the app. Follow the instructions to create a fly.io app using the template provided: + +```bash Install embedchain +pip install embedchain +``` ```bash Create application mkdir my-rag-app @@ -55,15 +59,17 @@ This will generate a directory structure like this: ├── fly.toml ├── .env ├── .env.example +├── embedchain.json └── requirements.txt ``` Feel free to edit the files as required. - `Dockerfile`: Defines the steps to setup the application -- `app.py`: Contains FastAPI app code +- `app.py`: Contains API app code - `fly.toml`: fly.io config file - `.env`: Contains environment variables for production - `.env.example`: Contains dummy environment variables (can ignore this file) +- `embedchain.json`: Contains embedchain specific configuration for deployment (you don't need to configure this) - `requirements.txt`: Contains python dependencies for your FastAPI application ## Step-3: Test app locally @@ -82,7 +88,7 @@ You can deploy to fly.io using the following command: ec deploy ``` -Once this step finished, it will provide you with the deployment endpoint where you can access the app live. It will look something like this: +Once this step finished, it will provide you with the deployment endpoint where you can access the app live. It will look something like this (Swagger docs): You can also check the logs, monitor app status etc on their dashboard by running command `fly dashboard`. diff --git a/docs/deployment/modal_com.mdx b/docs/deployment/modal_com.mdx new file mode 100644 index 00000000..783f96c8 --- /dev/null +++ b/docs/deployment/modal_com.mdx @@ -0,0 +1,63 @@ +--- +title: 'Modal.com' +description: 'Deploy your RAG application to modal.com platform' +--- + +Embedchain has a nice and simple abstraction on top of the [Modal.com](https://modal.com/) tools to let developers deploy RAG application to modal.com platform seamlessly. + +Follow the instructions given below to deploy your first application quickly: + + +## Step-1 Create RAG application: + +We provide a command line utility called `ec` in embedchain that inherits the template for `modal.com` platform and help you deploy the app. Follow the instructions to create a modal.com app using the template provided: + + +```bash Create application +pip install embedchain +mkdir my-rag-app +ec create --template=modal.com +``` + +This `create` command will open a browser window and ask you to login to your modal.com account and will generate a directory structure like this: + +```bash +├── app.py +├── .env +├── .env.example +├── embedchain.json +└── requirements.txt +``` + +Feel free to edit the files as required. +- `app.py`: Contains API app code +- `.env`: Contains environment variables for production +- `.env.example`: Contains dummy environment variables (can ignore this file) +- `embedchain.json`: Contains embedchain specific configuration for deployment (you don't need to configure this) +- `requirements.txt`: Contains python dependencies for your FastAPI application + +## Step-2: Test app locally + +You can run the app locally by simply doing: + +```bash Run locally +pip install -r requirements.txt +ec dev +``` + +## Step-3: Deploy to modal.com + +You can deploy to modal.com using the following command: +```bash Deploy app +ec deploy +``` + +Once this step finished, it will provide you with the deployment endpoint where you can access the app live. It will look something like this (Swagger docs): + + + +## Seeking help? + +If you run into issues with deployment, please feel free to reach out to us via any of the following methods: + + diff --git a/docs/mint.json b/docs/mint.json index 41713970..99223132 100644 --- a/docs/mint.json +++ b/docs/mint.json @@ -87,7 +87,8 @@ "group": "Deployment", "pages": [ "get-started/deployment", - "deployment/fly_io" + "deployment/fly_io", + "deployment/modal_com" ] }, { diff --git a/pyproject.toml b/pyproject.toml index 3a6cb0c9..92d047e7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "embedchain" -version = "0.1.34" +version = "0.1.35" description = "Data platform for LLMs - Load, index, retrieve and sync any unstructured data" authors = [ "Taranjeet Singh ",