Skip to content

Commit 1224951

Browse files
authored
docs[py]: Update docs for Py Client (#934)
* docs: increase clarity of pip extras and using oci+register method Signed-off-by: syntaxsdev <sglinton@redhat.com> * docs: update yr Signed-off-by: syntaxsdev <sglinton@redhat.com> * docs: update author for RTD footer Signed-off-by: syntaxsdev <sglinton@redhat.com> * docs: clarify oci registry Signed-off-by: syntaxsdev <sglinton@redhat.com> --------- Signed-off-by: syntaxsdev <sglinton@redhat.com>
1 parent 445f4f0 commit 1224951

2 files changed

Lines changed: 15 additions & 11 deletions

File tree

clients/python/README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,16 @@ This step is not required if you already installed the additional dependencies a
3838
```
3939
pip install huggingface-hub
4040
```
41+
#### Extras that can be installed
42+
```
43+
pip install model-registry[hf]
44+
```
45+
```
46+
pip install model-registry[s3]
47+
```
48+
```
49+
pip install model_registry[olot]
50+
```
4151

4252
## Basic usage
4353

@@ -208,7 +218,8 @@ registered_model = client.upload_artifact_and_register_model(
208218
```
209219

210220
#### OCI-registry based storage
211-
221+
First, you must ensure you are logged in the to appropriate OCI registry using
222+
`skopeo login`, `podman login`, or using another way of authenticating or subsequent lines below will fail.
212223
```python
213224
oci_upload_params = OCIParams(
214225
base_image="busybox",
@@ -226,7 +237,7 @@ registered_model = client.upload_artifact_and_register_model(
226237
)
227238
```
228239

229-
Additionally, OCI-based storage supports multiple CLI clients to perform the upload. However, one of these clients must be available in the hosts PATH. **Ensure your host has either [skopeo](https://github.com/containers/skopeo) or [oras](https://github.com/oras-project/oras) installed and available.**
240+
Additionally, OCI-based storage supports multiple CLI clients to perform the upload. However, one of these clients must be available in the hosts `$PATH`. **Ensure your host has either [skopeo](https://github.com/containers/skopeo) or [oras](https://github.com/oras-project/oras) installed and available.**
230241

231242
By default, `skopeo` is used to perform the OCI image download/upload.
232243

@@ -321,12 +332,5 @@ To run the e2e tests you will need [kind](https://kind.sigs.k8s.io/) to be insta
321332

322333
Check out our [recommendations on setting up your docker engine](https://github.com/kubeflow/model-registry/blob/main/CONTRIBUTING.md#docker-engine) on an ARM processor.
323334

324-
### Extras
325-
326-
Depending on your development flow, you need to install extra dependencies:
327-
328-
```
329-
poetry install -E "olot"
330-
```
331335

332336
<!-- github-only -->

clients/python/docs/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
"""Sphinx configuration."""
22

33
project = "model-registry"
4-
author = "Isabella Basso do Amaral"
5-
copyright = f"2023, {author}"
4+
author = "Model Registry Community"
5+
copyright = f"2025, {author}"
66
html_theme = "furo"
77
extensions = [
88
"sphinx.ext.autodoc", # support for automatic documentation

0 commit comments

Comments
 (0)