.. T-DeepInsight documentation master file, created by
   sphinx-quickstart on Tue Apr 25 13:31:22 2023.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


|Maintenance yes|

.. |Maintenance yes| image:: https://img.shields.io/badge/Maintained%3F-yes-green.svg
   :target: https://github.com/WanluLiuLab/TCR-DeepInsight
|PyPI version|

.. |PyPI version| image:: https://img.shields.io/badge/pypi-v0.10.11-blue
   :target: https://pypi.org/project/tcr-deep-insight/
|Docs passing|

.. |Docs passing| image:: https://readthedocs.org/projects/tcr-deepinsight/badge/?version=latest
   :target: https://tcr-deepinsight.readthedocs.io/en/latest/?badge=latest

Welcome to TCR-DeepInsight's documentation!
============================================

.. card:: Installation :octicon:`plug;1em;`
    :link: install
    :link-type: doc

    Click here to view a brief *TCR-DeepInsight* installation guide.


.. card:: API :octicon:`plug;1em;`
    :link: api
    :link-type: doc

    Click here to view a brief *TCR-DeepInsight* API documentation


.. card:: Knowledge base :octicon:`plug;1em;`
    :link: knowledge
    :link-type: doc

    Click here to view a *TCR-DeepInsight* knowledge base.

.. card:: GitHub :octicon:`mark-github;1em;`
    :link: https://github.com/WanluLiuLab/TCR-DeepInsight

    Ask questions, report bugs, and contribute to *TCR-DeepInsight* at our GitHub repository.

Contents
--------
.. toctree::

   intro
   install
   preprocessing
   tutorial
   api
   knowledge