PyABSA Documentation
=======================================


.. toctree::
   :maxdepth: 6
   :caption: Introduction

    Introduction <0_intro/introduction.md>
    Installation <0_intro/installation.md>


.. toctree::
   :maxdepth: 6
   :caption: Quick-Start
    Create (Annotate) Your Own Dataset <1_quick_start/annotate.md>
    Aspect-based Sentiment Classification <1_quick_start/absc.md>
    Aspect Term Extraction <1_quick_start/ate.md>
    Aspect Term Extraction and Sentiment Classification <1_quick_start/atesc.md>
    Adversarial Defense for Text Classification <1_quick_start/adversarial.md>
    Training BPE Tokenizer and Word2Vec Embedding <1_quick_start/bpe.md>
    Text Auto-augmentation <1_quick_start/autoaug.md>

.. toctree::
   :maxdepth: 6
   :caption: Configuration

    Customize Configuration <2_config/customize_config.md>

.. toctree::
   :maxdepth: 6
   :caption: Deploy Demo

    Aspect-based Sentiment Classification <3_inference/APC_flask_demo.ipynb>
    Aspect Sentiment Triplet Extraction <3_inference/ASTE_flask_demo.ipynb>
    Aspect Term Extraction and Sentiment Classification <3_inference/ATEPC_flask_demo.ipynb>

.. toctree::
   :maxdepth: 6
   :caption: Model Training

    Aspect-based Sentiment Classification <4_training/absc.md>
    Aspect Term Extraction <4_training/ate.md>
    Aspect Term Extraction and Sentiment Classification <4_training/atesc.md>


.. toctree::
   :maxdepth: 6
   :caption: Text Auto-augmentation

    Aspect-based Sentiment Classification <5_augmentation/absc.md>
    Text Classification <5_augmentation/text_classification.md>

.. toctree::
   :maxdepth: 6
   :caption: Tutorials

    Metrics Visualization <6_tutorials/metrics_visualization.md>
    Aspect-based Sentiment Classification <6_tutorials/Aspect_Sentiment_Classification.ipynb>
    Aspect Term Extraction and Sentiment Classification <6_tutorials/Aspect_Term_Extraction.ipynb>
    Aspect Sentiment Triplet Extraction <6_tutorials/Aspect_Sentiment_Triplet_Extraction.ipynb>

.. toctree::
   :maxdepth: 6
   :caption: Integrated Datasets

    Customized Datasets <7_datasets/customized_datasets.md>


.. toctree::
   :maxdepth: 6
   :caption: Supported Tasks

    Supported Tasks <8_supported_tasks/tasks.md>


.. toctree::
   :maxdepth: 6
   :caption: Citation

    Citation <9_citation/citation.md>

Contents
--------

.. toctree::

   PyABSA <autoapi/pyabsa>