Skip to content

📄 Update docs for PR #89 #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📄 Update docs for PR #89 #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions quick-start.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ title: Quick Start

<Note> Make sure you have followed the [installation](installation) steps before proceeding. </Note>


## Interactive View

1. Run Magemaker with your desired cloud provider:
Expand All @@ -21,7 +20,6 @@ Supported providers:
- `--cloud azure` Azure Machine Learning deployment
- `--cloud all` Configure all three providers at the same time


### List Models

From the dropdown, select `Show Acitve Models` to see the list of endpoints deployed.
Expand All @@ -34,14 +32,12 @@ From the dropdown, select `Delete a Model Endpoint` to see the list of models en

![Delete Endpoints](../Images/delete-1.png)


### Querying Models

From the dropdown, select `Query a Model Endpoint` to see the list of models endpoints. Press space to select the endpoints you want to query. Enter the query in the text box and press enter to get the response.

![Query Endpoints](../Images/query-1.png)


### YAML-based Deployment (Recommended)

For reproducible deployments, use YAML configuration:
Expand Down Expand Up @@ -119,15 +115,33 @@ models:
![Azure ML Creation](../Images/workspace-studio.png)
</Step>

<Step title="Select Hugging Face in the Collections List">
<Step title="Select Hugging Face in the Collections List">
Select Hugging-Face from the collections list. The id of the model card is the id you need to use in the yaml file
![Azure ML Creation](../Images/hugging-face.png)
</Step>

</Steps>
</Note>

### Additional CLI Arguments

Magemaker now supports more fine-grained control of deployment through extra arguments:

- `--instance`: EC2 (or equivalent) instance type to deploy to (e.g., `ml.g4dn.xlarge`)
- `--cpu`: Specify the desired CPU type for deployment (e.g., `intel`, `amd`)

Other supported flags:

- `--hf`: Deploy a Hugging Face model directly.
- `--deploy`: Path to YAML deployment configuration file (see above).
- `--cloud`: Target cloud providers.
- `--train`: Path to YAML training configuration file.
- `--version`: Show Magemaker version and exit.

Example:

```sh
magemaker --cloud aws --instance ml.g4dn.xlarge --cpu intel --hf facebook/opt-125m
```

### Model Fine-tuning

Expand Down Expand Up @@ -175,12 +189,10 @@ training: !Training
Remember to deactivate unused endpoints to avoid unnecessary charges!
</Warning>


## Contact

You can reach us, faizan & jneid, at [[email protected]](mailto:[email protected]).


If anything doesn't make sense or you have suggestions, do point them out at [magemaker.featurebase.app](https://magemaker.featurebase.app/).

We'd love to hear from you! We're excited to learn how we can make this more valuable for the community and welcome any and all feedback and suggestions.