Getting Started¶
Don’t know where to start? don’t worry!
- (Optional) Take a look at The SS3 Classification Model page to have a general idea of how the classifier works. We recommend reading, at least, the Introduction and the Hyperparameters section but if you get bored just ignore this step.
- Do at least one of the 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¶
- Getting Started - gives a brief introduction and overview.
- Installation Instructions - describes how to install PySS3 through pip or source.
- The Workflow - briefly describes the two main workflows.
- The SS3 Classification Model - briefly describes the classification model.
- Visualization Tools - details on the two main visualizations tools.
Tutorials¶
API Documentation¶
- PySS3 Package - the API documentation of PySS3.
About¶
- Change Log - documents major changes between versions.
- Contributions - gives instructions on how to contribute to PySS3.
- License - the license statement.