.. _getting-started:

***************
Getting Started
***************

Don't know where to start? don't worry!

1. (Optional) Take a look at :ref:`ss3-classifier` page to have a general idea of how the classifier works. We recommend reading, at least, the :ref:`ss3-introduction` and the :ref:`ss3-hyperparameter` section but if you get bored just ignore this step.
2. Do at least one of the :ref:`tutorials`.

Once you are done with these two steps, you will have a general knowledge of how to work with PySS3 :)

Finally, for specific topics you can read any of the following items.

Documentation Overview
=======================


User Guide
-----------

* :ref:`getting-started` - gives a brief introduction and overview.

* :ref:`installation` - describes how to install *PySS3* through pip or source.

* :ref:`workflow` - briefly describes the two main workflows.

* :ref:`ss3-classifier` - briefly describes the classification model.

* :ref:`visualizations` - details on the two main visualizations tools.


.. * :ref:`customization` - details on how to customize *PySS3*.

.. * :ref:`pyss3-command-line` - explained list of commands.


.. _tutorials:

Tutorials
----------

* :ref:`topic-categorization` 

* :ref:`movie-reviews`

* :ref:`extract-insight`

* :ref:`custom-preprocessing`


API Documentation
-----------------

* :ref:`api-doc` - the API documentation of *PySS3*. 


About
-------

* :ref:`changelog` - documents major changes between versions.

* :ref:`contributing` - gives instructions on how to contribute to *PySS3*.

* :ref:`license` - the license statement.