Metadata-Version: 2.1
Name: model-registry
Version: 0.1.0
Summary: Client for Red Hat OpenDataHub Model Registry
License: Apache-2.0
Author: Isabella Basso do Amaral
Author-email: idoamara@redhat.com
Requires-Python: >=3.9,<3.11
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: attrs (>=21.0,<22.0)
Requires-Dist: ml-metadata (>=1.14.0,<2.0.0)
Requires-Dist: typing-extensions (>=4.8,<5.0)
Description-Content-Type: text/markdown

# Model Registry Python Client

[![Python](https://img.shields.io/badge/python%20-3.9%7C3.10-blue)](https://github.com/opendatahub-io/model-registry)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](../../../LICENSE)

This library provides a high level interface for interacting with a model registry server.

## Basic usage

```py
from model_registry import ModelRegistry

registry = ModelRegistry(server_address="server-address", port=9090, author="author")

model = registry.register_model("my-model",
                                "s3://path/to/model",
                                model_format_name="onnx",
                                model_format_version="1",
                                storage_key="aws-connection-path",
                                storage_path="to/model",
                                version="v2.0",
                                description="lorem ipsum",
                                )

model = registry.get_registered_model("my-model")

version = registry.get_model_version("my-model", "v2.0")

experiment = registry.get_model_artifact("my-model", "v2.0")
```

## Development

Common tasks, such as building documentation and running tests, can be executed using [`nox`](https://github.com/wntrblm/nox) sessions.

Use `nox -l` to list sessions and execute them using `nox -s [session]`.

<!-- github-only -->

