Skip to content

Commit

Permalink
docs: use public urls in main readme, adjust recommended software for…
Browse files Browse the repository at this point in the history
… example 1
  • Loading branch information
lariel-fernandes committed Aug 21, 2024
1 parent 0e38549 commit b5ce962
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ A collection of MLOps tools for AI/ML/DS research and development.
- Support for nested tags/params/metrics and JSON-encoded tags/params for non-scalar types.
- Not dependent on env vars, global vars or a single global active run.

Check the tutorials in the [examples folder](examples)
Check the [tutorials](https://github.com/lariel-fernandes/mlopus/tree/main/examples)
for a friendly walkthrough of (almost) everything you can do with MLOpus.

A minimal API reference is also available [here](https://lariel-fernandes.github.io/mlopus/docs/api/stable/latest).
Expand Down
10 changes: 5 additions & 5 deletions examples/1_introduction/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ The notebooks in this example serve as a walkthrough for the basic features of M
For an overview of how those features work, have a look at the [architecture guide](../../docs/architecture.md).

### Recommended Software
1. [PyEnv](https://github.com/pyenv/pyenv#installation)
2. [Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
3. [Rclone CLI](https://rclone.org/install/#script-installation) (required for artifact transfer from/to cloud storage)
1. [UV](https://docs.astral.sh/uv/getting-started/installation/#standalone-installer)
2. [Rclone CLI](https://rclone.org/install/#script-installation) (required for artifact transfer from/to cloud storage)

### Python environment setup

Run this command from the **root** of this repository:
Run the following command from the **root** of this repository.
This will set up the virtualenv using UV and install the project code and dependencies.
```bash
make install
make install-project
```

### MLflow Sandbox
Expand Down

0 comments on commit b5ce962

Please sign in to comment.