ref: doctor +

content/docs/gto/command-reference/annotate.md

@@ -25,15 +25,17 @@ For example,
 $ gto annotate awesome-model \
   --type model \
   --path models/neural_network.h5 \
-  --label ml
-  --label cool
-  --description "This model is very cool"
+  --label ml \
+  --label cool \
+  --description "This model is very cool" \
+  --custom "{'foo': 'bar'}"
 ```
 
 will create
 
 ```yaml
 awesome-model:
+  custom: "{'foo': 'bar'}"
   description: This model is very cool
   labels:
     - ml
@@ -44,6 +46,11 @@ awesome-model:
 
 This information can be later retrieved by running `gto describe` command.
 
+`--custom` option allows you to add custom metadata. Within `gto annotate` GTO
+treats input as string, but you can edit artifacts.yaml to add arbitrary
+information that fits yaml format, such as dict or list, or more complex
+structures.
+
 <admon type="tip">
 
 Don't forget to commit `artifacts.yaml` with Git to associate it with the latest
@@ -79,6 +86,7 @@ GTO the artifact file is committed to Git.
 - `-e`, `--must-exist` - Verify artifact is committed to Git
 - `--label <text>` - Labels to add to artifact
 - `-d <text>`, `--description <text>` - Artifact description
+- `-c <text>`, `--custom <text>` - Custom metadata to add to artifact
 - `--commit` - Automatically commit changes due to this command (experimental)
 - `--push` - Push created commit automatically (experimental) - will set
   commit=True

content/docs/gto/command-reference/describe.md

@@ -26,7 +26,21 @@ $ gto describe churn -r https://github.com/iterative/example-gto
 }
 ```
 
-The output is in JSON format for ease of parsing programatically.
+The output is in JSON format for ease of parsing programmatically.
+
+Note, that for local repos the `artifacts.yaml` is read from the workspace
+without Git, so if you have uncommitted changes, they will be reflected in the
+output. If you want to read from specific commit, you need to specify `--rev`
+option.
+
+You can also get annotation for specific versions (these are the same shortcuts
+as in `gto show`):
+
+```cli
+$ gto describe churn@latest  # highest version by SemVer
+$ gto describe churn#dev     # version in stage `dev`
+$ gto describe [email protected]  # version `v3.0.0`
+```
 
 ## Options
 

content/docs/gto/command-reference/doctor.md

@@ -0,0 +1,36 @@
+# describe
+
+Display GTO version and check the registry for problems.
+
+## Synopsis
+
+```usage
+usage: gto doctor [-r <text>] [-A] [-h]
+```
+
+## Description
+
+This will check the registry and print all the issues if found:
+
+```cli
+$ gto doctor
+🪴  GTO Version: 0.2.5
+---------------------------------
+INDEX='artifacts.yaml'
+TYPES=None
+STAGES=None
+LOG_LEVEL='INFO'
+DEBUG=False
+ENRICHMENTS=[]
+AUTOLOAD_ENRICHMENTS=True
+CONFIG_FILE_NAME='.gto'
+EMOJIS=True
+---------------------------------
+✅  No issues found
+```
+
+## Options
+
+- `-r <text>`, `--repo <text>` - Local or remote repository [default: .]
+- `-A`, `--all-commits` - Read all commits
+- `-h`, `--help` - Show this message and exit.

content/docs/gto/command-reference/show.md

@@ -70,6 +70,13 @@ $ gto show churn#prod
 ╞════════════╪═══════════╪═════════╪═════════════════════╪══════════════╡
 │ churn      │ v3.0.0    │ prod    │ 2022-10-28 23:53:53 │ [email protected] │
 ╘════════════╧═══════════╧═════════╧═════════════════════╧══════════════╛
+
+$ gto show [email protected]
+╒════════════╤═══════════╤═════════╤═════════════════════╤══════════════╕
+│ artifact   │ version   │ stage   │ created_at          │ ref          │
+╞════════════╪═══════════╪═════════╪═════════════════════╪══════════════╡
+│ churn      │ v3.0.0    │ prod    │ 2022-10-28 23:53:53 │ [email protected] │
+╘════════════╧═══════════╧═════════╧═════════════════════╧══════════════╛
 ```
 
 By default, GTO is configured to adhere to what we call "Environments"

content/docs/gto/user-guide/dvc.md

@@ -87,9 +87,9 @@ learn how to find out `ARTIFACT_PATH` and `REVISION`.
 If you need to download the latest version of `model`, that would be:
 
 ```cli
-$ REVISION=$(gto show --repo $REPO model@greatest --ref)
-$ ARTIFACT_PATH=$(gto describe --repo $REPO $ARTIFACT --rev $REVISION --path)
-$ dvc get $REPO $ARTIFACT --rev $REVISION -o $ARTIFACT_PATH
+$ ARTIFACT_PATH=$(gto describe --repo $REPO model@latest --path)
+$ REVISION=$(gto show --repo $REPO model@latest --ref)
+$ dvc get $REPO $ARTIFACT_PATH --rev $REVISION -o $ARTIFACT_PATH
 ```
 
 </details>

content/docs/gto/user-guide/index.md

@@ -67,7 +67,7 @@ You may need the artifact's file path. If
 `gto describe`:
 
 ```cli
-$ gto describe churn --rev churn@v3.0.0 --path
+$ gto describe [email protected] --path
 models/churn.pkl
 ```
 

content/docs/gto/user-guide/mlem.md

@@ -77,6 +77,12 @@ jobs:
     name: Build a Docker image for new model versions
     runs-on: ubuntu-latest
     steps:
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        # set credentials to login to DockerHub
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
       - uses: actions/checkout@v3
       - id: gto
         uses: iterative/gto-action@v1
@@ -87,13 +93,11 @@ jobs:
           pip install -r requirements.txt
       - if: steps.gto.outputs.event == 'registration'
         run: |
-          # TODO: check this works
-          # What credentials we need to specify to publish image somewhere?
           mlem build docker \
               --model '${{ steps.gto.outputs.path }}' \
               --image.name ${{ steps.gto.outputs.name }} \
               --image.tag '${{ steps.gto.outputs.version }}' \
-              --env.registry docker_io
+              --image.registry docker_io
 ```
 
 Note that builder can be
@@ -112,7 +116,7 @@ on:
     tags:
       - '*'
 
-# specify credentials needed to run deployment and keep the deployment state
+# set credentials to run deployment and save its state to s3
 env:
   HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
   AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}

content/docs/sidebar.json

@@ -623,6 +623,11 @@
             "slug": "dvc",
             "label": "GTO with DVC",
             "source": "dvc.md"
+          },
+          {
+            "slug": "mlem",
+            "label": "GTO with MLEM",
+            "source": "mlem.md"
           }
         ]
       },
@@ -661,6 +666,11 @@
             "source": "describe.md",
             "label": "describe"
           },
+          {
+            "slug": "doctor",
+            "source": "doctor.md",
+            "label": "doctor"
+          },
           {
             "slug": "history",
             "source": "history.md",