Skip to content

Commit fa66f95

Browse files
Narek MkhitaryanNarek Mkhitaryan
authored andcommitted
remove consensus function in docs
1 parent 57a09c0 commit fa66f95

File tree

4 files changed

+0
-77
lines changed

4 files changed

+0
-77
lines changed

docs/source/api_reference/helpers.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,3 @@ ________________________
2424
.. automethod:: superannotate.SAClient.aggregate_annotations_as_df
2525

2626
----------
27-
28-
Utility functions
29-
--------------------------------
30-
31-
.. autofunction:: superannotate.SAClient.consensus

docs/source/userguide/quickstart.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,6 @@ It can be installed on Ubuntu with:
2525
2626
sudo apt-get install ffmpeg
2727
28-
To use the :py:obj:`consensus` function on Windows and Mac platforms, you might also need to install the shapely package
29-
beforehand. The package works well only under the Anaconda distribution with:
30-
31-
.. code-block:: bash
32-
33-
conda install shapely
34-
3528
----------
3629

3730

docs/source/userguide/utilities.rst

Lines changed: 0 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -126,64 +126,3 @@ Example of created DataFrame:
126126

127127
Each row represents annotation information. One full annotation with multiple
128128
attribute groups can be grouped under :code:`instanceId` field.
129-
130-
131-
Working with DICOM files
132-
------------------------
133-
134-
JPEG images with names :file:`<dicom_file_name>_<frame_num>.jpg` will be created
135-
in :file:`<path_to_output_dir>`. Those JPEG images can be uploaded to
136-
SuperAnnotate platform using the regular:
137-
138-
.. code-block:: python
139-
140-
sa.upload_images_from_folder_to_project(project, "<path_to_output_dir>")
141-
142-
Some DICOM files can have image frames that are compressed. To load them, `GDCM :
143-
Grassroots DICOM library <http://gdcm.sourceforge.net/wiki/index.php/Main_Page>`_ needs to be installed:
144-
145-
.. code-block:: bash
146-
147-
# using conda
148-
conda install -c conda-forge gdcm
149-
150-
# or on Ubuntu with versions above 19.04
151-
sudo apt install python3-gdcm
152-
153-
Computing consensus scores for instances between several projects
154-
-----------------------------------------------------------------
155-
156-
157-
Consensus is a tool to compare the quallity of the annotations of the same image that is present in several projects.
158-
To compute the consensus scores:
159-
160-
.. code-block:: python
161-
162-
res_df = sa.consensus([project_names], "<path_to_export_folder>", [image_list], "<annotation_type>")
163-
164-
Here pandas DataFrame with following columns is returned: creatorEmail, imageName, instanceId, className, area, attribute, projectName, score
165-
166-
.. image:: images/consensus_dataframe.png
167-
168-
Besides the pandas DataFrame there is an option to get the following plots by setting the show_plots flag to True:
169-
170-
* Box plot of consensus scores for each annotators
171-
* Box plot of consensus scores for each project
172-
* Scatter plots of consensus score vs instance area for each project
173-
174-
.. code-block:: python
175-
176-
sa.consensus([project_names], "<path_to_export_folder>", [image_list], "<annotation_type>", show_plots=True)
177-
178-
To the left of each box plot the original score points of that annotator is depicted, the box plots are colored by annotator.
179-
180-
.. image:: images/consensus_annotators_box.png
181-
182-
Analogically the box plots of consensus scores for each project are colored according to project name.
183-
184-
.. image:: images/consensus_projects_box.png
185-
186-
Scatter plot of consensus score vs instance area is separated by projects. Hovering on a point reveals its annotator and image name.
187-
The points are colored according to class name. Each annotator is represented with separate symbol.
188-
189-
.. image:: images/consensus_scatter.png

src/superannotate/lib/app/interface/sdk_interface.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1514,10 +1514,6 @@ def download_export(
15141514
to_s3_bucket=None,
15151515
):
15161516
"""Download prepared export.
1517-
1518-
WARNING: Starting from version 1.9.0 :ref:`download_export <ref_download_export>` additionally
1519-
requires :py:obj:`project` as first argument.
1520-
15211517
:param project: project name
15221518
:type project: str
15231519
:param export: export name

0 commit comments

Comments
 (0)