Metadata-Version: 2.4
Name: aiod-registry
Version: 0.1
Summary: A registry of models for use with AI OnDemand (AIoD)
Project-URL: homepage, https://github.com/FrancisCrickInstitute/aiod_registry
Project-URL: documentation, https://franciscrickinstitute.github.io/aiod_docs/sections/model_registry/
Project-URL: source, https://github.com/FrancisCrickInstitute/aiod_registry
Author-email: Cameron Shand <cameron.shand@crick.ac.uk>, Numan Ahmed <numan.ahmed@crick.ac.uk>, Qin Yu <qin.yu@crick.ac.uk>, Fiona Young <fiona.young@crick.ac.uk>, Jon Smith <jon.smith@crick.ac.uk>
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Python: <3.13,>=3.11
Requires-Dist: pydantic>=2.0
Requires-Dist: pyyaml
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Description-Content-Type: text/markdown

# AIoD Model Registry
This repository contains the central manifests/schemas that defines the models available within AIoD.

In addition, are:

- Tests for validating schemas
- Utility functions for ingesting the schemas and filtering by whether a user has access to each model, enabling us to [automatically write the UI for our Napari plugin](https://franciscrickinstitute.github.io/aiod_docs/sections/development/#automatic-ui-construction)

## Installation

```
git clone https://github.com/FrancisCrickInstitute/AIoD-Model-Registry.git
cd AIoD-Model-Registry/
pip install .
```

or

```
pip install git+https://github.com/FrancisCrickInstitute/AIoD-Model-Registry.git
```

## Contact Details
* cameron.shand@crick.ac.uk
* jon.smith@crick.ac.uk

## Contribution Guidelines
See our [documentation](https://franciscrickinstitute.github.io/aiod_docs/sections/contributing/expanding/) for guidance on adding models to this repo.

### Local Validation
To locally test whether a new manifest is eligible, simply run `pytest -v tests/`, where any errors will be detailed by Pydantic.
