Skip to content

Commit 396a2ad

Browse files
Removed cvat section (#486)
1 parent 4f7665c commit 396a2ad

File tree

1 file changed

+0
-99
lines changed

1 file changed

+0
-99
lines changed

Diff for: docs/source/tutorials/projects.rst

-99
Original file line numberDiff line numberDiff line change
@@ -602,105 +602,6 @@ The interpolation algorithm can also be run from sample frames kept locally, wit
602602

603603
All that is required is a ``<feature_hash>`` and ``object_hash`` for each object in your set of key frames.
604604

605-
606-
Other Resources
607-
===============
608-
609-
CVAT Integration
610-
----------------
611-
612-
If you are currently using :xref:`cvat` for image and video annotations, we have made it easy to import your entire project or single tasks to |company|.
613-
This will create the ontology and import all labels and classifications.
614-
615-
Exporting Your CVAT Work
616-
^^^^^^^^^^^^^^^^^^^^^^^^
617-
You can either export an entire project or an individual task.
618-
Keep in mind that every new export will create an entirely new project.
619-
620-
Exporting from the CVAT UI
621-
""""""""""""""""""""""""""
622-
623-
For project exports:
624-
625-
.. figure:: /images/cvat_project_export.png
626-
627-
Export Project.
628-
629-
Or for task exports:
630-
631-
.. figure:: /images/cvat_task_export.png
632-
633-
Export Task.
634-
635-
Then in the popup, please ensure that images are saved too:
636-
637-
.. figure:: /images/cvat_project_export_popup.png
638-
:width: 450
639-
640-
Export Project.
641-
642-
643-
Once this is downloaded, you can unzip the file to create a directory which contains all your images/videos, together with an `annotations.xml` file which contains your CVAT ontology, CVAT labels, and CVAT tags (which are the equivalent of Encord Classifications for entire images/frames).
644-
645-
Importing with the |sdk|
646-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
647-
648-
.. note::
649-
As imports can take quite some time, we recommend increasing the :class:`.EncordUserClient` request timeouts as described here :ref:`tutorials/configurations:Network configurations`.
650-
651-
652-
653-
.. tabs::
654-
655-
.. tab:: Code
656-
657-
.. literalinclude:: /code_examples/tutorials/projects/cvat_importer.py
658-
:language: python
659-
660-
.. tab:: Example output
661-
662-
.. code-block:: python
663-
664-
project_hash = "0a5c5a7e-da96-44c1-a355-a53259c0e73e"
665-
dataset_hash = "bd19ef7c-b698-434f-a7cc-d3c01fc5da3e"
666-
encord.utilities.client_utilities.Issues(
667-
errors=[],
668-
warnings=[
669-
encord.utilities.client_utilities.Issue(
670-
issue_type='In Encord a specific label can only have one possible shape. If '
671-
'the same label is used for multiple shapes, multiple labels need '
672-
'to be created.',
673-
instances=[
674-
"The label `not_yet_annotated` was used for multiple shapes "
675-
"`[<CvatShape.POLYGON: 'polygon'>, <CvatShape.TAG: 'tag'>]`. "
676-
"Each shape which is translatable to Encord will lead to a "
677-
"distinct editor entry."
678-
]
679-
)
680-
],
681-
infos=[]
682-
)
683-
issues = None
684-
685-
686-
If the return object is a :class:`.CvatImporterSuccess`, you can open the web app and will find that the project was already added.
687-
688-
For possible import options and return types consult the in :meth:`code documentation <.EncordUserClient.create_project_from_cvat>`.
689-
690-
The :class:`Issues <.client_utilities.Issues>` Object - CVAT to Encord Import Limitations
691-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
692-
693-
We encourage you to inspect the returned :class:`Issues <.client_utilities.Issues>` object closely.
694-
This will inform you about possible limitations during the project/task import.
695-
696-
For example, within CVAT the same label in the ontology can be used for different shapes.
697-
Within Encord, a label in the ontology is bound to a specific shape.
698-
During import, the importer will detect whether the same CVAT label was used for multiple shapes and create different Encord ontology items for each of them.
699-
700-
There are other limitations which are documented in the :class:`Issues <.client_utilities.Issues>` object.
701-
Please reach out to the Encord team if those need clarification.
702-
703-
704605
API keys
705606
========
706607
We recommend using a :class:`encord.project.Project` as described in :ref:`tutorials/projects:Managing a project`.

0 commit comments

Comments
 (0)