Skip to content
This repository has been archived by the owner on Oct 16, 2024. It is now read-only.

docs: admonitions #67

Merged
merged 14 commits into from
May 27, 2022
36 changes: 20 additions & 16 deletions content/docs/api-reference/pack.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,33 @@ from mlem.api import pack
pack("pip", "rf", target="build", package_name="example_mlem_get_started")
```

> The extra kwargs supplied above can be seen from the output of
> `mlem types packager pip` which gives us
>
> ```py
> [required] package_name: str
> [required] target: str
> [not required] templates_dir: str = []
> [not required] python_version: str = None
> [not required] short_description: str = ""
> [not required] url: str = ""
> [not required] email: str = ""
> [not required] author: str = ""
> [not required] version: str = "0.0.0"
> [not required] additional_setup_kwargs: typing.Any = {}
> ```

## Description

This API is the underlying mechanism for the
[mlem pack](/doc/command-reference/pack) command and allows us to
programmatically create ship-able assets from MlemModels such as pip-ready
packages, docker images, etc.

<amon type="tip">
yathomasi marked this conversation as resolved.
Show resolved Hide resolved

The arguments supplied to this method can be found with `mlem types`:

```cli
$ mlem types packager pip
[required] package_name: str
[required] target: str
[not required] templates_dir: str = []
[not required] python_version: str = None
[not required] short_description: str = ""
[not required] url: str = ""
[not required] email: str = ""
[not required] author: str = ""
[not required] version: str = "0.0.0"
[not required] additional_setup_kwargs: typing.Any = {}
```

</admon>

## Parameters

- **`packager`** (required) - Packager to use. Out-of-the-box supported string
Expand Down
8 changes: 6 additions & 2 deletions content/docs/command-reference/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,12 @@ Add a remote object to your local workspace (aka repo) without copying it
$ mlem link rf --source-repo https://github.com/iterative/example-mlem-get-started remote_model
```

> The remote model can now be served with the link created above, using the
> command `mlem serve remote_model fastapi`.
<amon type="tip">

The remote model can now be served with the link created above, using the
command `mlem serve remote_model fastapi`.

</admon>

Alias a local object with a different name

Expand Down
6 changes: 5 additions & 1 deletion content/docs/command-reference/pprint.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,11 @@ as object specific information such as `methods` for a `model` or `reader` for a
Since only one specific object is printed, a `PATH` to the specific MLEM object
is always required.

> You can use [`mlem list`](/doc/command-reference/list) to list MLEM objects.
<amon type="tip">

You can use [`mlem list`](/doc/command-reference/list) to list MLEM objects.

</admon>

## Options

Expand Down
6 changes: 5 additions & 1 deletion content/docs/contributing/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,11 @@ Make sure that you have Python 3.7 or higher installed. On macOS, we recommend
using `brew` to install Python. For Windows, we recommend an official
[python.org release](https://www.python.org/downloads/windows/).

> ℹ️ Note that `pip` version 20.3+ is required.
<amon type="info">

`pip` version 20.3+ is required.

</admon>

Install MLEM in editable mode with `pip install -e ".[tests]"`. But before we do
that, we **strongly** recommend creating a
Expand Down
14 changes: 9 additions & 5 deletions content/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@
It seamlessly supports a variety of scenarios like real-time serving and batch
processing.

> 💡 When combined with [GTO](https://github.com/iterative/gto), MLEM allows you
> to create a powerful Model Registry out of your Git repository! Such a
> registry serves as a centralized place to store and operationalize your models
> along with their metadata; manage model life-cycle, versions & releases, and
> easily automate tests and deployments using GitOps.
<amon type="tip">

💡 When combined with [GTO](https://github.com/iterative/gto), MLEM allows you
to create a powerful Model Registry out of your Git repository! Such a registry
serves as a centralized place to store and operationalize your models along with
jorgeorpinel marked this conversation as resolved.
Show resolved Hide resolved
their metadata; manage model life-cycle, versions & releases, and easily
automate tests and deployments using GitOps.

</admon>

<cards>

Expand Down