.. Meerkat documentation master file, created by
   sphinx-quickstart on Fri Jan  1 16:41:09 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Meerkat
==========================================
Meerkat provides fast and flexible data structures for working with complex machine 
learning datasets. It is designed to house your data throughout the machine learning 
lifecycle – along the way enabling interactive data exploration, cross-modal training, and 
fine-grained error analysis. 


.. code-block::
    
    pip install meerkat-ml

See :doc:`start/install` for detailed instructions.


Next Steps
~~~~~~~~~~~~

.. panels::

    Get started with Meerkat by following along on Google Colab. 

    .. link-button:: https://drive.google.com/file/d/15kPD6Kym0MOpICafHgO1pCt8T2N_xevM/view?usp=sharing 
        :classes: btn-primary btn-block stretched-link
        :text: Walkthrough Notebook
    ---

    Learn more about the motivation behind Meerkat and what it enables. 

    .. link-button:: https://www.notion.so/sabrieyuboglu/Meerkat-DataPanels-for-Machine-Learning-64891aca2c584f1889eb0129bb747863
        :classes: btn-primary btn-block stretched-link
        :text: Introductory Blog Post 


.. _Issues: https://github.com/robustness-gym/meerkat/issues/



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

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