Skip to content

Commit

Permalink
Update README/docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pm3310 committed Jan 5, 2024
1 parent b5c4840 commit 568821c
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 4 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
![Sagify](docs/sagify@2x.png)

<p align="center">
<em>Machine Learning Engineering done easily.</em>
<em>LLMs and Machine Learning done easily.</em>
</p>
<p align="center">
<a href="https://github.com/cortisolai/cortisol/actions?query=workflow%3ACI" target="_blank">
Expand All @@ -11,7 +11,7 @@

# sagify

A command-line utility to train and deploy Machine Learning/Deep Learning models on [AWS SageMaker](https://aws.amazon.com/sagemaker/) in a few simple steps! It hides all the details of Sagemaker so that you can focus 100% on Machine Learning, and not in low level engineering tasks.
A command-line utility to train and deploy LLMs and Machine Learning/Deep Learning models on [AWS SageMaker](https://aws.amazon.com/sagemaker/) in a few simple steps! It hides all the details of Sagemaker so that you can focus 100% on Machine Learning, and not in low level engineering tasks.

For detailed reference to Sagify commands please go to: [Read the Docs](https://Kenza-AI.github.io/sagify/)

Expand All @@ -32,6 +32,20 @@ At the command line:
pip install sagify


## Getting started - LLM Deployment with no code
1. Make sure to configure your AWS account by following the instructions at section [Configure AWS Account](#configure-aws-account)

2. Finally, run the following command:

```sh
sagify cloud foundation-model-deploy --model-id model-txt2img-stabilityai-stable-diffusion-v2-1-base --model-version 1.* -n 1 -e ml.p3.2xlarge --aws-region us-east-1 --aws-profile sagemaker-dev
```
You can change the values for ec2 type (-e), aws region and aws profile with your preferred ones.

3. Once the Stable Diffusion model is deployed, you can use the generated code snippet to query it. Enjoy!

## Getting started - No code deployment

1. Create a file with name `huggingface_config.json` with the following content:
Expand Down
18 changes: 16 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

![Sagify](sagify@2x.png)

A command-line utility to train and deploy Machine Learning/Deep Learning models on [AWS SageMaker](https://aws.amazon.com/sagemaker/) in a few simple steps!
A command-line utility to train and deploy LLMs and Machine Learning/Deep Learning models on [AWS SageMaker](https://aws.amazon.com/sagemaker/) in a few simple steps!

![gif](end2end.gif)

## Why Sagify?

"Why should I use Sagify" you may ask.

We'll provide you with some examples of how Sagify can simplify and expedite your ML pipelines. You can train, tune and deploy a Machine Learning on the same day by using Sagify!
We'll provide you with some examples of how Sagify can simplify and expedite your ML pipelines. You can train, tune and deploy a Machine Learning or just deploy an LLM on the same day by using Sagify!

### No More Configuring Cloud Instances for Training a Machine Learning Model

Expand Down Expand Up @@ -59,6 +59,20 @@ At the command line:
pip install sagify
```

## Getting started - LLM Deployment with no code
1. Make sure to configure your AWS account by following the instructions at section [Configure AWS Account](#configure-aws-account)

2. Finally, run the following command:

```sh
sagify cloud foundation-model-deploy --model-id model-txt2img-stabilityai-stable-diffusion-v2-1-base --model-version 1.* -n 1 -e ml.p3.2xlarge --aws-region us-east-1 --aws-profile sagemaker-dev
```
You can change the values for ec2 type (-e), aws region and aws profile with your preferred ones.

3. Once the Stable Diffusion model is deployed, you can use the generated code snippet to query it. Enjoy!

## Getting started - No code deployment

1. Create a file with name `huggingface_config.json` with the following content:
Expand Down

0 comments on commit 568821c

Please sign in to comment.