From b5ce9629c6f1b2faf889df8a6e9102532a14403d Mon Sep 17 00:00:00 2001 From: Lariel Fernandes Date: Wed, 21 Aug 2024 22:00:44 +0200 Subject: [PATCH] docs: use public urls in main readme, adjust recommended software for example 1 --- README.md | 2 +- examples/1_introduction/README.md | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d00f7b6..e897038 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/examples/1_introduction/README.md b/examples/1_introduction/README.md index da24f8c..ff8feb0 100644 --- a/examples/1_introduction/README.md +++ b/examples/1_introduction/README.md @@ -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