Skip to content

Commit

Permalink
explain monorepo case
Browse files Browse the repository at this point in the history
  • Loading branch information
aguschin committed Jul 12, 2023
1 parent 5059499 commit 3e22bfc
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions content/docs/studio/rest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,12 @@ HTTP Method: GET
If no version specified, the latest one is returned.
When your model is annotated in non-root `dvc.yaml` file (typical for monorepo
case), model name will be constructed from two parts separated by colon:
`path/to/dvc/yaml:model_name`. For example, take a loot at this
[model from example-get-started-experiments repo](https://studio.iterative.ai/user/aguschin/models/VtQdva13kMSPsN_N8004aQ==/pool-segmentation/v1.0.1).
Its full name that you need to use in API is `results/train:pool-segmentation`.

| header | desc | example value |
| ------------- | --------------- | ------------- |
| Authorization | Header for auth | token abc123 |
Expand Down

0 comments on commit 3e22bfc

Please sign in to comment.