diff options
| author | jwansek <eddie.atten.ea29@gmail.com> | 2022-05-01 16:03:24 +0100 |
|---|---|---|
| committer | jwansek <eddie.atten.ea29@gmail.com> | 2022-05-01 16:03:24 +0100 |
| commit | abc7f067ff20bc2bd07d9236c30055549481547c (patch) | |
| tree | d486cb4efda107633bcf243e5f60fdebd7094e5f /docs/source/assessments.rst | |
| parent | ee1b57ec6197c554f3c011f9a648e2222d845994 (diff) | |
| download | Smarker-abc7f067ff20bc2bd07d9236c30055549481547c.tar.gz Smarker-abc7f067ff20bc2bd07d9236c30055549481547c.zip | |
Finished plagarism detector, added docs
Diffstat (limited to 'docs/source/assessments.rst')
| -rw-r--r-- | docs/source/assessments.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/source/assessments.rst b/docs/source/assessments.rst new file mode 100644 index 0000000..a8d7311 --- /dev/null +++ b/docs/source/assessments.rst @@ -0,0 +1,24 @@ +.. _assessments: + +``assessments.py`` +================== + +``assessments.py`` contains many useful arguments for interacting with the database: + +.. argparse:: + :module: assessments + :func: getparser + :prog: python Smarker/assessments.py + +Classes +******* + +.. autoclass:: assessments.SimilarityMetric + :members: + +Functions +********* + +.. autofunction:: assessments.visualise_matrix + +.. autofunction:: assessments.generate_plagarism_report
\ No newline at end of file |