Add mlem get started

.pre-commit-config.yaml

@@ -45,7 +45,7 @@ repos:
   - id: isort
     args: [--profile=black, -l=99]
 - repo: https://github.com/ambv/black
-  rev: 21.5b1
+  rev: 22.3.0
   hooks:
   - id: black
     args: [-l, '99']

example-mlem-get-started/.gitattributes

@@ -0,0 +1,2 @@
+*.dvc linguist-language=YAML
+dvc.lock linguist-language=YAML

example-mlem-get-started/.gitignore

@@ -0,0 +1,4 @@
+# Custom
+*.zip
+/tmp
+build/

example-mlem-get-started/code/README.md

@@ -0,0 +1,37 @@
+# MLEM Get Started
+
+This is an auto-generated repository for use in MLEM
+[Get Started](https://mlem.ai/doc/get-started). It is a step-by-step quick
+introduction into basic MLEM concepts.
+
+🐛 Please report any issues found in this project here -
+[example-repos-dev](https://github.com/iterative/example-repos-dev).
+
+## Installation
+
+Python 3.6+ is required to run code from this repo.
+
+```console
+$ git clone https://github.com/iterative/example-mlem-get-started
+$ cd example-mlem-get-started
+```
+
+Now let's install the requirements. But before we do that, we **strongly**
+recommend creating a virtual environment with a tool such as
+[virtualenv](https://virtualenv.pypa.io/en/stable/):
+
+```console
+$ virtualenv -p python3 .env
+$ source .env/bin/activate
+$ pip install -r src/requirements.txt
+```
+
+## Existing stages
+
+This project with the help of the Git tags reflects the sequence of actions that
+are run in the MLEM [get started](https://mlem.ai/doc/get-started) guide. Feel
+free to checkout one of them and play with the MLEM commands having the
+playground ready.
+
+[comment]: <> (TODO)
+- `0-git-init`: Empty Git repository initialized.

example-mlem-get-started/code/src/evaluate.py

@@ -0,0 +1,18 @@
+import json
+
+from mlem.api import apply
+from mlem.core.metadata import load
+from sklearn import metrics
+
+
+def main():
+    y_pred = apply("rf", "test_x.csv", method="predict_proba")
+    y_true = load("test_y.csv")
+    roc_auc = metrics.roc_auc_score(y_true, y_pred, multi_class="ovr")
+
+    with open("metrics.json", "w") as fd:
+        json.dump({"roc_auc": roc_auc}, fd, indent=4)
+
+
+if __name__ == "__main__":
+    main()

example-mlem-get-started/code/src/prepare.py

@@ -0,0 +1,16 @@
+from mlem.api import save
+from sklearn.datasets import load_iris
+from sklearn.model_selection import train_test_split
+
+
+def main():
+    data, y = load_iris(return_X_y=True, as_frame=True)
+    data["target"] = y
+    train_data, test_data = train_test_split(data, random_state=42)
+    save(train_data, "train.csv")
+    save(test_data.drop("target", axis=1), "test_x.csv")
+    save(test_data[["target"]], "test_y.csv")
+
+
+if __name__ == "__main__":
+    main()

example-mlem-get-started/code/src/requirements.txt

@@ -0,0 +1,4 @@
+pandas
+scikit-learn
+scipy
+dvc[azure]

example-mlem-get-started/code/src/train.py

@@ -0,0 +1,24 @@
+from mlem.api import load, save
+from sklearn.ensemble import RandomForestClassifier
+
+
+def main():
+    df = load("train.csv")
+    data = df.drop("target", axis=1)
+    rf = RandomForestClassifier(
+        n_jobs=2,
+        random_state=42,
+    )
+    rf.fit(data, df.target)
+
+    save(
+        rf,
+        "rf",
+        tmp_sample_data=data,
+        tags=["random-forest", "classifier"],
+        description="Random Forest Classifier",
+    )
+
+
+if __name__ == "__main__":
+    main()

example-mlem-get-started/generate.sh

@@ -0,0 +1,156 @@
+#!/bin/bash
+# See https://dvc.org/doc/tutorials/get-started
+
+# Setup script env:
+#   e   Exit immediately if a command exits with a non-zero exit status.
+#   u   Treat unset variables as an error when substituting.
+#   x   Print commands and their arguments as they are executed.
+set -eux
+
+HERE="$( cd "$(dirname "$0")" ; pwd -P )"
+REPO_NAME="example-mlem-get-started"
+
+BUILD_PATH="$HERE/build"
+
+pushd $BUILD_PATH
+if [ ! -d "$BUILD_PATH/.venv" ]; then
+  exit 1
+  virtualenv -p python3 .venv
+  export VIRTUAL_ENV_DISABLE_PROMPT=true
+  source .venv/bin/activate
+  echo '.venv/' > .gitignore
+  pip install gitpython
+  pip install "git+https://github.com/iterative/mlem#egg=mlem[all]" --use-deprecated=legacy-resolver
+  pip install -r $HERE/code/src/requirements.txt
+fi
+popd
+
+source $BUILD_PATH/.venv/bin/activate
+
+REPO_PATH="$HERE/build/$REPO_NAME"
+
+if [ -d "$REPO_PATH" ]; then
+  echo "Repo $REPO_PATH already exists, please remove it first."
+  exit 1
+fi
+
+TOTAL_TAGS=15
+STEP_TIME=100000
+BEGIN_TIME=$(( $(date +%s) - ( ${TOTAL_TAGS} * ${STEP_TIME}) ))
+export TAG_TIME=${BEGIN_TIME}
+export GIT_AUTHOR_DATE=${TAG_TIME}
+export GIT_COMMITTER_DATE=${TAG_TIME}
+tick(){
+  export TAG_TIME=$(( ${TAG_TIME} + ${STEP_TIME} ))
+  export GIT_AUTHOR_DATE=${TAG_TIME}
+  export GIT_COMMITTER_DATE=${TAG_TIME}
+}
+
+export GIT_AUTHOR_NAME="Mikhail Sveshnikov"
+export GIT_AUTHOR_EMAIL="[email protected]"
+export GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
+export GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
+
+
+
+mkdir -p $REPO_PATH
+pushd $REPO_PATH
+
+git init -b main
+cp $HERE/code/README.md .
+cp $HERE/.gitattributes .
+git add .
+tick
+git commit -m "Initialize Git repository"
+git tag -a "0-git-init" -m "Git initialized."
+
+mlem init
+tick
+git add .mlem/config.yaml
+git commit -m "Initialize MLEM project"
+git tag -a "1-mlem-init" -m "MLEM initialized."
+
+
+cp $HERE/code/src/requirements.txt .
+cp $HERE/code/src/prepare.py .
+git add .
+python prepare.py
+git add .mlem/dataset
+tick
+git commit -m "Create data stage"
+git tag -a "2-prepare-stage" -m "Data created."
+
+
+cp $HERE/code/src/train.py .
+python train.py
+git add .mlem/model train.py
+tick
+git commit -m "Create train stage"
+git tag -a "3-train-stage" -m "Model trained."
+
+
+cp $HERE/code/src/evaluate.py .
+python evaluate.py
+git add metrics.json evaluate.py
+tick
+git commit -m "Evaluate model"
+git tag -a "4-eval-stage" -m "Metrics calculated"
+
+git rm -r --cached .mlem/model/rf .mlem/dataset/train.csv .mlem/dataset/test_x.csv .mlem/dataset/test_y.csv
+git commit -m "stop tracking data"
+
+dvc init
+dvc remote add myremote azure://example-mlem --default
+mlem config set default_storage.type dvc
+python train.py
+dvc add .mlem/model/rf .mlem/dataset/train.csv .mlem/dataset/test_x.csv .mlem/dataset/test_y.csv
+git add .mlem
+tick
+git commit -m "Switch to dvc storage"
+git tag -a "5-switch-to-dvc" -m "Switched to DVC"
+dvc push
+
+popd
+
+unset TAG_TIME
+unset GIT_AUTHOR_DATE
+unset GIT_COMMITTER_DATE
+unset GIT_AUTHOR_NAME
+unset GIT_AUTHOR_EMAIL
+unset GIT_COMMITTER_NAME
+unset GIT_COMMITTER_EMAIL
+
+echo "`cat <<EOF-
+
+The Git repo generated by this script is intended to be published on
+https://github.com/iterative/example-mlem-get-started. Make sure the Github repo
+exists first and that you have appropriate write permissions.
+
+To create it with https://cli.github.com/, run:
+
+gh repo create iterative/example-mlem-get-started --public \
+     -d "Get Started MLEM project" -h "https://mlem.ai/doc/get-started"
+
+Run these commands to force push it:
+
+cd build/example-mlem-get-started
+git remote add origin  https://github.com/iterative/example-mlem-get-started
+git push --force origin main
+git push --force origin --tags
+cd ../../
+
+Run these to drop and then rewrite the experiment references on the repo:
+
+git ls-remote origin "refs/exps/*" | awk '{print \\$2}' | xargs -n 1 git push -d origin
+dvc exp list --all --names-only | xargs -n 1 dvc exp push origin
+
+
+Finally, return to the directory where you started:
+
+cd ../..
+
+You may remove the generated repo with:
+
+rm -fR build
+
+`"