Skip to content

Commit

Permalink
Add initial docs about custom stacks
Browse files Browse the repository at this point in the history
  • Loading branch information
Christopher-Norman committed Sep 4, 2023
1 parent 8aa4dd3 commit 2407652
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ We've put a lot of thought into what our users — data scientists, ML engineers
* Somewhere to deploy and serve models in a way that scales with your application needs.
* The ability to monitor models for things like drift and bias.

Matcha is still in alpha release, and we don't support everything on that list yet. We support experiment tracking, training, and deployment, with plans to add data versioning and monitoring later. We very much welcome input on our roadmap from our early users.
Matcha is still in alpha release, and we don't support everything on that list yet. We support experiment tracking, training, data version control and deployment, with plans to add monitoring later. We very much welcome input on our roadmap from our early users.

## 👏 Contributing

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ We've put a lot of thought into what our users — data scientists, ML engineers
* Somewhere to deploy and serve models in a way that scales with your application needs.
* The ability to monitor models for things like drift and bias.

Matcha is still in alpha release, and we don't support everything on that list yet. We support experiment tracking, training, and deployment, with plans to add data versioning and monitoring later. We very much welcome input on our roadmap from our early users.
Matcha is still in alpha release, and we don't support everything on that list yet. We support experiment tracking, training, data versioning and deployment, with plans to add monitoring later. We very much welcome input on our roadmap from our early users.

# Who maintains Matcha?

Expand Down
45 changes: 45 additions & 0 deletions docs/resource-stacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,49 @@ $ matcha stack set llm

If no stack is set Matcha will use the 'default' stack.


## Custom stacks

Need an additional module or to remove one? The custom stack is for you.

You can start by adding a module to your stack as follows:

```bash
$ matcha stack add experiment_tracker mlflow
```

```bash
$ matcha stack add <module_type> <flavor>
```

If you want to adapt one of the stacks above you can do this by first setting your stack:

```bash
$ matcha stack set llm
```

then adding/removing a module from the stack

```bash
$ matcha stack remove orchestrator
```

and then Matcha provision the specified resources:

```bash
$ matcha provision
```

### Available Modules

| Module Type | Flavors | Example Usage (add) | Example Usage (remove) |
|----------------------|---------|----------------------------------------------|---------------------------------------|
| orchestrator | zenml | `matcha stack add orchestrator zenml` | `matcha stack remove orchestrator` |
| experiment_tracker | mlflow | `matcha stack add experiment_tracker mflow` | `matcha stack remove orchestrator` |
| data_version_control | dvc | `matcha stack add data_version_control mflow`| `matcha stack remove data_version_control`|
| deployer | seldon | `matcha stack add deployer seldon` | `matcha stack remove deployer` |
| vector_database | chroma | `matcha stack add vector_database chroma` | `matcha stack remove vector_database` |

> Note: If you have existing provisioned resources, you must destroy them before adding a new module.
See the [API documentation](references.md) for more information.

0 comments on commit 2407652

Please sign in to comment.