summaryrefslogtreecommitdiffstats
path: root/docs/source/assessments.rst
blob: cd92fe1f7a4986acf5ed50315a87e1ed803ea258 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.. _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:

.. autoclass:: assessments.StringSimilarity
    :inherited-members:
    :members:

Functions
*********

.. autofunction:: assessments.visualise_matrix

.. autofunction:: assessments.generate_plagarism_report