diff options
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 |