.. dagshub documentation master file, created by
   sphinx-quickstart on Mon Nov 27 16:25:22 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to DagsHub client's documentation!
============================================

This is the API reference for the `DagsHub Python Client <https://github.com/DagsHub/client>`_.

To install the client in your environment:

.. code-block:: console

    pip install dagshub

If you're working in a Google Colab/jupyter environment,
run ``pip install dagshub[jupyter]`` to install additional dependencies to enhance your experience.

.. toctree::
    :maxdepth: 1

    Back to DagsHub Docs <https://dagshub.com/docs>
    reference/cli
    reference/setup
    reference/auth
    reference/data_engine/index
    reference/file_downloading
    reference/file_uploading
    reference/repo_bucket
    reference/ls_client
    reference/loading_models
    reference/repo_api
    reference/notebook
    reference/mlflow_util
    reference/troubleshooting


..  Files after this one are hidden and aren't exposed (not exposing them to the user due to deprecation)
    reference/metric_logging
    reference/index


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

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