.. neomaril-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.

Neomaril-Codex
==============

Its a Package for interacting with Neomaril.
Neomaril is an API for Machine Learning (ML) models management, allowing the users to train, deploy and monitor those models.
The users will need to host its Python scripts and notebooks to Neomaril-Codex to use the Neomaril API.


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

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

.. code:: python

   pip install neomaril-codex


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

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

.. toctree::
   :maxdepth: 2
   
   starters


Beside that several `notebooks <https://github.com/datarisk-io/mlops-neomaril-codex/tree/master/notebooks>`_ gives examples of how to use Neomaril-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 neomaril_codex.* namespace are public.


.. toctree::
   :maxdepth: 4
   :caption: Docs:

   neomaril_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-neomaril-codex.git@master

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

- Manuella Dias Cruz: https://github.com/ManuDiasCruz
- Jonathan Carvalho: https://github.com/johnrc90
- Guilherme Cardoso: https://github.com/gkardoso

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

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