.. mlops_codex documentation master file, created by
   sphinx-quickstart on Wed Feb  1 16:39:34 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

MLOps Codex
==============

MLOps Codex is a Python package designed to facilitate interaction with MLOps platforms.
Datarisk MLOps is a comprehensive platform for managing Machine Learning (ML) models, enabling users to seamlessly train, deploy, and monitor their models.
To utilize the MLOps API, users must host their Python scripts and notebooks within the MLOps Codex environment.

Installation
---------------

The package is available on PyPI and can thus be installed with:

.. code:: python

   pip install datarisk-mlops-codex


Getting started
---------------

Check our guide on how to use MLOps Codex to manage models 

.. toctree::
   :maxdepth: 2
   
   starters


Beside that several `notebooks <https://github.com/datarisk-io/mlops_codex/tree/master/notebooks>`_ gives examples of how to use MLOps-Codex to manage, deploy and other package functionalities.
You can find it at:


Package Reference
-----------------

Gives an overview of all objects, functions and methods.
All classes and functions exposed in mlops_codex.* namespace are public.


.. toctree::
   :maxdepth: 3
   :caption: Docs:

   mlops_codex


Development Version
-------------------

If you want to track the development version of the package, you can install it from the git repo:

.. code:: python

   pip install git+https://github.com/datarisk-io/mlops_codex.git@master


Maintainers
-----------

- Manuella Dias Cruz: https://github.com/ManuDiasCruz
- Jonathan Carvalho: https://github.com/johnrc90
- Luís Henrique: https://github.com/henrique-lh

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`