Skip to content

Commit 267af65

Browse files
authored
doc: simplify readme (#115)
* doc: simplify readme * doc: simplify readme
1 parent 82c5022 commit 267af65

File tree

11 files changed

+12
-31
lines changed

11 files changed

+12
-31
lines changed

README.md

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -22,39 +22,27 @@
2222

2323
## Introduction
2424

25-
Easy Model Deployer is a lightweight tool designed to simplify the deployment of **Open-Source LLMs** ([Supported Models](docs/en/supported_models.md)) and Custom Models. It provides **OpenAI's Completions API** and [**LangChain Interface**](https://github.com/langchain-ai/langchain). Built for developers who need reliable and scalable model serving without complex setup, it seamlessly integrates with AWS services for efficient model deployment.
25+
Easy Model Deployer is a lightweight tool designed for simplify deploy **Open-Source LLMs** ([Supported Models](docs/en/supported_models.md)) and Custom Models on AWS. It provides **OpenAI's Completions API** and [**LangChain Interface**](https://github.com/langchain-ai/langchain). Built for developers who need reliable and scalable model serving without complex environment setup.
2626

27-
![cli](docs/images/cli-all.gif)
27+
![cli](docs/images/demo.avif)
2828

2929
**Key Features**
3030

31-
- One-click deployment of models to the cloud (Amazon SageMaker, Amazon ECS, Amazon EC2)
31+
- One-click deployment of models to AWS (Amazon SageMaker, Amazon ECS, Amazon EC2)
3232
- Diverse model types (LLMs, VLMs, Embeddings, Vision, etc.)
3333
- Rich inference engine (vLLM, TGI, Lmdeploy, etc.)
3434
- Different instance types (CPU/GPU/AWS Inferentia)
3535
- Convenient integration (OpenAI Compatible API, LangChain client, etc.)
3636

37-
## 🚀 Quick Install
37+
## 🔧 Get Started
3838

39-
Install Easy Model Deployer with `pip`, currently support for Python 3.9 and above:
39+
### Installation
4040

41-
```bash
42-
pip install easy_model_deployer # or pip3 install easy_model_deployer
43-
emd
44-
```
45-
46-
Visit our [documentation](https://aws-samples.github.io/easy-model-deployer/en/installation/) to learn more.
47-
48-
## 🔧 Usage
49-
50-
### (Optional) Configure AWS Profile
51-
52-
> If you have already configured your AWS credentials using the AWS CLI, you can skip this step.
53-
54-
You can configure the AWS profile by EMD. If you don't set any AWS profile, the EMD will use the default credentials in your terminal, you can also configure your credentials by [`aws configure`](https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html#cli-configure-files-methods).
41+
Install Easy Model Deployer with PyPI, currently support for Python 3.9 or above:
5542

5643
```bash
57-
emd config set-default-profile-name
44+
pip install easy-model-deployer
45+
emd
5846
```
5947

6048
### Bootstrap
@@ -67,18 +55,16 @@ For more information, please refer to [Architecture](https://aws-samples.github.
6755
emd bootstrap
6856
```
6957

70-
> **💡 Tip** Once you upgrade the EMD by `pip`, you need to run this command again.
58+
> **💡 Tip** Once you upgrade the EMD by `pip`, you need to run this command again to update the environment.
7159
72-
### Deploy Model
60+
### Deploy Models
7361

74-
Deploy models with an interactive CLI or one command.
62+
Deploy models with an interactive CLI or one command line.
7563

7664
```bash
7765
emd deploy
7866
```
7967

80-
![deploy](docs/images/cli-deploy.gif)
81-
8268
> **💡 Tip** To view all available parameters, run `emd deploy --help`.
8369
> When you see the message "Waiting for model: ...", it means the deployment task has started and you can stop the terminal output by pressing `Ctrl+C`.
8470
>
@@ -95,7 +81,7 @@ emd status
9581

9682
> **💡 Tip** The EMD allows launch multiple deployment tasks simultaneously.
9783
98-
### Quick Invocation
84+
### Invocation
9985

10086
Invoke the deployed model for testing by CLI.
10187

@@ -120,11 +106,6 @@ Quickly see what models are supported, this command will output all information
120106
emd list-supported-models
121107
```
122108

123-
The following command is recommended to just list the model types.
124-
125-
```bash
126-
emd list-supported-models | jq -r '.[] | "\(.model_id)\t\(.model_type)"' | column -t -s $'\t' | sort
127-
```
128109

129110
### Delete Model
130111

docs/images/cli-all.gif

-11.3 MB
Binary file not shown.

docs/images/cli-deploy.gif

-3.45 MB
Binary file not shown.

docs/images/cli.gif

-5.27 MB
Binary file not shown.

docs/images/demo.avif

1.34 MB
Binary file not shown.

docs/images/emd-bootstrap.png

-524 KB
Binary file not shown.

docs/images/emd-config.png

-32.5 KB
Binary file not shown.

docs/images/emd-deploy.png

-419 KB
Binary file not shown.

docs/images/emd-destroy.png

-91.8 KB
Binary file not shown.

docs/images/emd-invoke.png

-83.4 KB
Binary file not shown.

0 commit comments

Comments
 (0)