Update documentation sorting (#3320)
* update documentation sorting * update README.md and documentation * fix linter errors * update name sections * fix links * fix linter errors * update developing section * fix link and mistake * rename developing and contributing section * fix incorrect links * fix link on cvat.jpg * Update site/content/en/docs/_index.md Co-authored-by: Nikita Manovich <nikita.manovich@intel.com>main
Timur Osmanov
5 years ago
committed by
GitHub
parent
c730920d69
commit
7cf6c7a08e
@ -0,0 +1,9 @@
|
||||
---
|
||||
|
||||
title: 'Administration'
|
||||
linkTitle: 'Administration'
|
||||
weight: 3
|
||||
description: 'This section contains documents for system administrators'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
|
||||
title: 'Administration (advanced)'
|
||||
linkTitle: 'Advanced'
|
||||
weight: 2
|
||||
description: 'This section contains basic documents for system administrators'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
|
||||
title: 'Administration (basics)'
|
||||
linkTitle: 'Basics'
|
||||
weight: 1
|
||||
description: 'This section contains basic documents for system administrators'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -0,0 +1,16 @@
|
||||
---
|
||||
title: 'Contributing to this project'
|
||||
linkTitle: 'Contributing'
|
||||
weight: 4
|
||||
description: 'This section contains documents for CVAT developers'
|
||||
hide_feedback: true
|
||||
ul_show: false
|
||||
---
|
||||
|
||||
Please take a moment to review this document in order to make the contribution
|
||||
process easy and effective for everyone involved.
|
||||
|
||||
Following these guidelines helps to communicate that you respect the time of
|
||||
the developers managing and developing this open source project. In return,
|
||||
they should reciprocate that respect in addressing your issue or assessing
|
||||
patches and features.
|
||||
@ -0,0 +1,15 @@
|
||||
---
|
||||
title: 'Branching model'
|
||||
linkTitle: 'Branching model'
|
||||
weight: 5
|
||||
---
|
||||
|
||||
The project uses [a successful Git branching model](https://nvie.com/posts/a-successful-git-branching-model).
|
||||
Thus it has a couple of branches. Some of them are described below:
|
||||
|
||||
- `origin/master` to be the main branch where the source code of
|
||||
HEAD always reflects a production-ready state
|
||||
|
||||
- `origin/develop` to be the main branch where the source code of
|
||||
HEAD always reflects a state with the latest delivered development
|
||||
changes for the next release. Some would call this the “integration branch”.
|
||||
@ -0,0 +1,42 @@
|
||||
---
|
||||
title: 'Bug reports'
|
||||
linkTitle: 'Bug reports'
|
||||
weight: 7
|
||||
---
|
||||
|
||||
A bug is a _demonstrable problem_ that is caused by the code in the repository.
|
||||
Good bug reports are extremely helpful - thank you!
|
||||
|
||||
Guidelines for bug reports:
|
||||
|
||||
1. **Use the GitHub issue search** — check if the issue has already been
|
||||
reported.
|
||||
|
||||
2. **Check if the issue has been fixed** — try to reproduce it using the
|
||||
latest `develop` branch in the repository.
|
||||
|
||||
3. **Isolate the problem** — ideally create a reduced test case.
|
||||
|
||||
A good bug report shouldn't leave others needing to chase you up for more
|
||||
information. Please try to be as detailed as possible in your report. What is
|
||||
your environment? What steps will reproduce the issue? What browser(s) and OS
|
||||
experience the problem? What would you expect to be the outcome? All these
|
||||
details will help people to fix any potential bugs.
|
||||
|
||||
Example:
|
||||
|
||||
> Short and descriptive example bug report title
|
||||
>
|
||||
> A summary of the issue and the browser/OS environment in which it occurs. If
|
||||
> suitable, include the steps required to reproduce the bug.
|
||||
>
|
||||
> 1. This is the first step
|
||||
> 1. This is the second step
|
||||
> 1. Further steps, etc.
|
||||
>
|
||||
> Any other information you want to share that is relevant to the issue being
|
||||
> reported. This might include the lines of code that you have identified as
|
||||
> causing the bug, and potential solutions (and your opinions on their
|
||||
> merits).
|
||||
|
||||
<a name="features"></a>
|
||||
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: 'JavaScript/Typescript coding style'
|
||||
linkTitle: 'JavaScript/Typescript coding style'
|
||||
weight: 4
|
||||
---
|
||||
|
||||
We use the [Airbnb JavaScript Style Guide](https://github.com/airbnb/javascript) for JavaScript code with a
|
||||
little exception - we prefer 4 spaces for indentation of nested blocks and statements.
|
||||
@ -0,0 +1,113 @@
|
||||
---
|
||||
title: 'Development environment'
|
||||
linkTitle: 'Development environment'
|
||||
weight: 2
|
||||
---
|
||||
|
||||
- Install necessary dependencies:
|
||||
|
||||
Ubuntu 18.04
|
||||
|
||||
```sh
|
||||
sudo apt-get update && sudo apt-get --no-install-recommends install -y build-essential curl redis-server python3-dev python3-pip python3-venv python3-tk libldap2-dev libsasl2-dev pkg-config libavformat-dev libavcodec-dev libavdevice-dev libavutil-dev libswscale-dev libswresample-dev libavfilter-dev
|
||||
```
|
||||
|
||||
```sh
|
||||
# Node and npm (you can use default versions of these packages from apt (8.*, 3.*), but we would recommend to use newer versions)
|
||||
curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
|
||||
sudo apt-get install -y nodejs
|
||||
```
|
||||
|
||||
MacOS 10.15
|
||||
|
||||
```sh
|
||||
brew install git python pyenv redis curl openssl node
|
||||
```
|
||||
|
||||
- Install FFmpeg libraries (libav\*) version 4.0 or higher.
|
||||
|
||||
- Install [Visual Studio Code](https://code.visualstudio.com/docs/setup/linux#_debian-and-ubuntu-based-distributions)
|
||||
for development
|
||||
|
||||
- Install CVAT on your local host:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/openvinotoolkit/cvat
|
||||
cd cvat && mkdir logs keys
|
||||
python3 -m venv .env
|
||||
. .env/bin/activate
|
||||
pip install -U pip wheel setuptools
|
||||
pip install -r cvat/requirements/development.txt
|
||||
python manage.py migrate
|
||||
python manage.py collectstatic
|
||||
```
|
||||
|
||||
> Note for Mac users
|
||||
>
|
||||
> If you have any problems with installing dependencies from
|
||||
> `cvat/requirements/*.txt`, you may need to reinstall your system python
|
||||
> In some cases after system update it can be configured incorrectly and cannot compile some native modules
|
||||
|
||||
- Create a super user for CVAT:
|
||||
|
||||
```sh
|
||||
$ python manage.py createsuperuser
|
||||
Username (leave blank to use 'django'): ***
|
||||
Email address: ***
|
||||
Password: ***
|
||||
Password (again): ***
|
||||
```
|
||||
|
||||
- Install npm packages for UI and start UI debug server (run the following command from CVAT root directory):
|
||||
|
||||
```sh
|
||||
npm ci && \
|
||||
cd cvat-core && npm ci && \
|
||||
cd ../cvat-ui && npm ci && npm start
|
||||
```
|
||||
|
||||
> Note for Mac users
|
||||
>
|
||||
> If you faced with error
|
||||
>
|
||||
> `Node Sass does not yet support your current environment: OS X 64-bit with Unsupported runtime (57)`
|
||||
>
|
||||
> Read this article [Node Sass does not yet support your current environment](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)
|
||||
|
||||
- Open new terminal (Ctrl + Shift + T), run Visual Studio Code from the virtual environment
|
||||
|
||||
```sh
|
||||
cd .. && source .env/bin/activate && code
|
||||
```
|
||||
|
||||
- Install following VS Code extensions:
|
||||
|
||||
- [Debugger for Chrome](https://marketplace.visualstudio.com/items?itemName=msjsdiag.debugger-for-chrome)
|
||||
- [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
|
||||
- [ESLint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
|
||||
- [Stylelint](https://marketplace.visualstudio.com/items?itemName=stylelint.vscode-stylelint)
|
||||
- [vscode-remark-lint](https://marketplace.visualstudio.com/items?itemName=drewbourne.vscode-remark-lint)
|
||||
- [licenser](https://marketplace.visualstudio.com/items?itemName=ymotongpoo.licenser)
|
||||
- [Trailing Spaces](https://marketplace.visualstudio.com/items?itemName=shardulm94.trailing-spaces)
|
||||
|
||||
- Reload Visual Studio Code from virtual environment
|
||||
|
||||
- Select `server: debug` configuration and start it (F5) to run REST server and its workers
|
||||
|
||||
You have done! Now it is possible to insert breakpoints and debug server and client of the tool.
|
||||
|
||||
## Note for Windows users
|
||||
|
||||
You develop CVAT under WSL (Windows subsystem for Linux) following next steps.
|
||||
|
||||
- Install WSL using [this guide](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
|
||||
|
||||
- Following this guide install Ubuntu 18.04 Linux distribution for WSL.
|
||||
|
||||
- Run Ubuntu using start menu link or execute next command
|
||||
|
||||
```powershell
|
||||
wsl -d Ubuntu-18.04
|
||||
```
|
||||
|
||||
- Run all commands from this installation guide in WSL Ubuntu shell.
|
||||
@ -0,0 +1,12 @@
|
||||
---
|
||||
title: 'Feature requests'
|
||||
linkTitle: 'Feature requests'
|
||||
weight: 8
|
||||
---
|
||||
|
||||
Feature requests are welcome. But take a moment to find out whether your idea
|
||||
fits with the scope and aims of the project. It's up to _you_ to make a strong
|
||||
case to convince the project's developers of the merits of this feature. Please
|
||||
provide as much detail and context as possible.
|
||||
|
||||
<a name="pull-requests"></a>
|
||||
@ -0,0 +1,70 @@
|
||||
---
|
||||
title: 'Pull requests'
|
||||
linkTitle: 'Pull requests'
|
||||
weight: 9
|
||||
---
|
||||
|
||||
Good pull requests - patches, improvements, new features - are a fantastic
|
||||
help. They should remain focused in scope and avoid containing unrelated
|
||||
commits.
|
||||
|
||||
**Please ask first** before embarking on any significant pull request (e.g.
|
||||
implementing features, refactoring code, porting to a different language),
|
||||
otherwise you risk spending a lot of time working on something that the
|
||||
project's developers might not want to merge into the project.
|
||||
|
||||
Please adhere to the coding conventions used throughout a project (indentation,
|
||||
accurate comments, etc.) and any other requirements (such as test coverage).
|
||||
|
||||
Follow this process if you'd like your work considered for inclusion in the
|
||||
project:
|
||||
|
||||
1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) the project, clone your fork,
|
||||
and configure the remotes:
|
||||
|
||||
```bash
|
||||
# Clone your fork of the repo into the current directory
|
||||
git clone https://github.com/<your-username>/<repo-name>
|
||||
# Navigate to the newly cloned directory
|
||||
cd <repo-name>
|
||||
# Assign the original repo to a remote called "upstream"
|
||||
git remote add upstream https://github.com/<upstream-owner>/<repo-name>
|
||||
```
|
||||
|
||||
1. If you cloned a while ago, get the latest changes from upstream:
|
||||
|
||||
```bash
|
||||
git checkout <dev-branch>
|
||||
git pull upstream <dev-branch>
|
||||
```
|
||||
|
||||
1. Create a new topic branch (off the main project development branch) to
|
||||
contain your feature, change, or fix:
|
||||
|
||||
```bash
|
||||
git checkout -b <topic-branch-name>
|
||||
```
|
||||
|
||||
1. Commit your changes in logical chunks. Please adhere to these [git commit
|
||||
message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
|
||||
or your code is unlikely be merged into the main project. Use Git's
|
||||
[interactive rebase](https://docs.github.com/en/github/using-git/about-git-rebase)
|
||||
feature to tidy up your commits before making them public.
|
||||
|
||||
1. Locally merge (or rebase) the upstream development branch into your topic branch:
|
||||
|
||||
```bash
|
||||
git pull [--rebase] upstream <dev-branch>
|
||||
```
|
||||
|
||||
1. Push your topic branch up to your fork:
|
||||
|
||||
```bash
|
||||
git push origin <topic-branch-name>
|
||||
```
|
||||
|
||||
1. [Open a Pull Request](hhttps://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)
|
||||
with a clear title and description.
|
||||
|
||||
**IMPORTANT**: By submitting a patch, you agree to allow the project owner to
|
||||
license your work under the same license as that used by the project.
|
||||
@ -0,0 +1,17 @@
|
||||
---
|
||||
title: 'Using the issue tracker'
|
||||
linkTitle: 'Using the issue tracker'
|
||||
weight: 6
|
||||
---
|
||||
|
||||
The issue tracker is the preferred channel for [bug reports](#bugs),
|
||||
[features requests](#features) and [submitting pull
|
||||
requests](#pull-requests), but please respect the following restrictions:
|
||||
|
||||
- Please **do not** use the issue tracker for personal support requests (use
|
||||
[Stack Overflow](http://stackoverflow.com)).
|
||||
|
||||
- Please **do not** derail or troll issues. Keep the discussion on topic and
|
||||
respect the opinions of others.
|
||||
|
||||
<a name="bugs"></a>
|
||||
@ -1,11 +0,0 @@
|
||||
<!--lint disable maximum-heading-length-->
|
||||
|
||||
---
|
||||
|
||||
title: 'For Developers'
|
||||
linkTitle: 'For Developers'
|
||||
weight: 3
|
||||
description: 'This section contains documents for system administrators, AI researchers and any other advanced users.'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -1,11 +0,0 @@
|
||||
<!--lint disable heading-style-->
|
||||
|
||||
---
|
||||
|
||||
title: 'For Users'
|
||||
linkTitle: 'For Users'
|
||||
weight: 2
|
||||
description: 'This section contains documents for CVAT users'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -1,15 +0,0 @@
|
||||
---
|
||||
title: "User's guide"
|
||||
linkTitle: "User's guide"
|
||||
weight: 1
|
||||
description: "This multipage document contains information on how to work with the CVAT user interface"
|
||||
---
|
||||
Computer Vision Annotation Tool (CVAT) is a web-based tool which helps to
|
||||
annotate videos and images for Computer Vision algorithms. It was inspired
|
||||
by [Vatic](http://carlvondrick.com/vatic/) free, online, interactive video
|
||||
annotation tool. CVAT has many powerful features: _interpolation of bounding
|
||||
boxes between key frames, automatic annotation using deep learning models,
|
||||
shortcuts for most of critical actions, dashboard with a list of annotation
|
||||
tasks, LDAP and basic authorization, etc..._ It was created for and used by
|
||||
a professional data annotation team. UX and UI were optimized especially for
|
||||
computer vision tasks developed by our team.
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
title: "Advanced"
|
||||
linkTitle: "Advanced"
|
||||
weight: 30
|
||||
---
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
title: "Annotation with points"
|
||||
linkTitle: "Annotation with points"
|
||||
weight: 10
|
||||
---
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
title: "Annotation with polygons"
|
||||
linkTitle: "Annotation with polygons"
|
||||
weight: 8
|
||||
---
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
title: "Basics"
|
||||
linkTitle: "Basics"
|
||||
weight: 8
|
||||
---
|
||||
@ -0,0 +1,60 @@
|
||||
---
|
||||
title: "Getting started"
|
||||
linkTitle: "Getting started"
|
||||
weight: 1
|
||||
---
|
||||
|
||||
This section contains basic information and links to sections necessary for a quick start.
|
||||
|
||||
## Installation
|
||||
|
||||
First step is to install CVAT on your system. Use the [Installation Guide](/docs/administration/basics/installation/).
|
||||
|
||||
## Getting started in CVAT
|
||||
|
||||
To find out more, go to the [authorization](/docs/manual/basics/authorization/) section.
|
||||
|
||||
To create a task, go to `Tasks` section. Click `Create new task` to go to the task creation page.
|
||||
|
||||
Set the name of the future task.
|
||||
|
||||
Set the label using the constructor: first click "add label", then enter the name of the label and choose the color.
|
||||
|
||||
|
||||
|
||||
You need to upload images or videos for your future annotation. To do so, simply drag and drop the files.
|
||||
|
||||
To learn more, go to [creating an annotation task](/docs/manual/basics/creating_an_annotation_task/)
|
||||
|
||||
## Basic annotation
|
||||
|
||||
When the task is created, you will see a corresponding message in the top right corner.
|
||||
Click the "Open task" button to go to the task page.
|
||||
|
||||
Once on the task page, open a link to the job in the jobs list.
|
||||
|
||||
Choose a correct section for your type of the task and start annotation.
|
||||
|
||||
| Shape | Annotation | Interpolation |
|
||||
| --------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
|
||||
| Rectangle | [Shape mode (basics)](/docs/manual/basics/shape-mode-basics/) | [Track mode (basics)](/docs/manual/basics/track-mode-basics/) |
|
||||
| Polygon | [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/) | [Track mode with polygons](/docs/manual/advanced/annotation-with-polygons/track-mode-with-polygons/) |
|
||||
| Polyline | [Annotation with polylines](/docs/manual/advanced/annotation-with-polylines/) | |
|
||||
| Points | [Points in shape mode](/docs/manual/advanced/annotation-with-points/points-in-shape-mode/) | [Liner interpolation with one point](/docs/manual/advanced/annotation-with-points/liner-interpolation-with-one-point/) |
|
||||
| Cuboids | [Annotation with cuboids](/docs/manual/advanced/annotation-with-cuboids/) | [Editing the cuboid](/docs/manual/advanced/annotation-with-cuboids/editing-the-cuboid/) |
|
||||
| Tag | [Annotation with tags](/docs/manual/advanced/annotation-with-tags/) | |
|
||||
|
||||
## Dump annotation
|
||||
|
||||
|
||||
|
||||
1. To download the annotations, first you have to save all changes.
|
||||
Click the Save button or press `Ctrl+S`to save annotations quickly.
|
||||
|
||||
2. After you saved the changes, click the Menu button.
|
||||
|
||||
3. Then click the Dump Annotation button.
|
||||
|
||||
4. Lastly choose a format of the dump annotation file.
|
||||
|
||||
To learn more, go to [downloading annotations](/docs/manual/advanced/downloading-annotations/)
|
||||
@ -0,0 +1,9 @@
|
||||
---
|
||||
|
||||
title: 'Manual'
|
||||
linkTitle: 'Manual'
|
||||
weight: 2
|
||||
description: 'This section contains documents for CVAT simple and advanced users'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Advanced"
|
||||
linkTitle: "Advanced"
|
||||
weight: 2
|
||||
description: 'This section contains advanced documents for CVAT users'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Analytics"
|
||||
linkTitle: "Analytics"
|
||||
weight: 1
|
||||
title: 'Analytics'
|
||||
linkTitle: 'Analytics'
|
||||
weight: 28
|
||||
---
|
||||
|
||||
If your CVAT instance was created with analytics support, you can press the `Analytics` button in the dashboard
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Annotation with cuboids"
|
||||
linkTitle: "Annotation with cuboids"
|
||||
weight: 11
|
||||
title: 'Annotation with cuboids'
|
||||
linkTitle: 'Annotation with cuboids'
|
||||
weight: 17
|
||||
---
|
||||
|
||||
It is used to annotate 3 dimensional objects such as cars, boxes, etc...
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: 'Annotation with points'
|
||||
linkTitle: 'Annotation with points'
|
||||
weight: 11
|
||||
---
|
||||
@ -0,0 +1,5 @@
|
||||
---
|
||||
title: 'Annotation with polygons'
|
||||
linkTitle: 'Annotation with polygons'
|
||||
weight: 13
|
||||
---
|
||||
@ -1,17 +1,17 @@
|
||||
---
|
||||
title: "Track mode with polygons"
|
||||
linkTitle: "Track mode with polygons"
|
||||
title: 'Track mode with polygons'
|
||||
linkTitle: 'Track mode with polygons'
|
||||
weight: 5
|
||||
---
|
||||
|
||||
Polygons in the track mode allow you to mark moving objects more accurately other than using a rectangle
|
||||
([Tracking mode (basic)](/docs/for-users/user-guide/basics/track-mode-basics/); [Tracking mode (advanced)](/docs/for-users/user-guide/advanced/track-mode-advanced/)).
|
||||
([Tracking mode (basic)](/docs/manual/basics/track-mode-basics/); [Tracking mode (advanced)](/docs/manual/advanced/track-mode-advanced/)).
|
||||
|
||||
1. To create a polygon in the track mode, click the `Track` button.
|
||||
|
||||
|
||||
|
||||
1. Create a polygon the same way as in the case of [Annotation with polygons](/docs/for-users/user-guide/advanced/annotation-with-polygons/).
|
||||
1. Create a polygon the same way as in the case of [Annotation with polygons](/docs/manual/advanced/annotation-with-polygons/).
|
||||
Press `N` to complete the polygon.
|
||||
|
||||
1. Pay attention to the fact that the created polygon has a starting point and a direction,
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Annotation with polylines"
|
||||
linkTitle: "Annotation with polylines"
|
||||
weight: 9
|
||||
title: 'Annotation with polylines'
|
||||
linkTitle: 'Annotation with polylines'
|
||||
weight: 12
|
||||
---
|
||||
It is used for road markup annotation etc.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Annotation with rectangle by 4 points"
|
||||
linkTitle: "Annotation with rectangle by 4 points"
|
||||
weight: 7
|
||||
title: 'Annotation with rectangle by 4 points'
|
||||
linkTitle: 'Annotation with rectangle by 4 points'
|
||||
weight: 10
|
||||
---
|
||||
|
||||
It is an efficient method of bounding box annotation, proposed
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Annotation with Tags"
|
||||
linkTitle: "Annotation with Tags"
|
||||
weight: 12
|
||||
title: 'Annotation with Tags'
|
||||
linkTitle: 'Annotation with Tags'
|
||||
weight: 16
|
||||
---
|
||||
|
||||
It is used to annotate frames, tags are not displayed in the workspace.
|
||||
@ -1,10 +1,10 @@
|
||||
---
|
||||
title: "Attribute annotation mode (advanced)"
|
||||
linkTitle: "Attribute annotation mode"
|
||||
weight: 3
|
||||
title: 'Attribute annotation mode (advanced)'
|
||||
linkTitle: 'Attribute annotation mode'
|
||||
weight: 6
|
||||
---
|
||||
|
||||
Basic operations in the mode were described in section [attribute annotation mode (basics)](/docs/for-users/user-guide/basics/attribute-annotation-mode-basics/).
|
||||
Basic operations in the mode were described in section [attribute annotation mode (basics)](/docs/manual/basics/attribute-annotation-mode-basics/).
|
||||
|
||||
It is possible to handle lots of objects on the same frame in the mode.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Automatic annotation"
|
||||
linkTitle: "Automatic annotation"
|
||||
weight: 14
|
||||
title: 'Automatic annotation'
|
||||
linkTitle: 'Automatic annotation'
|
||||
weight: 27
|
||||
---
|
||||
|
||||
Automatic Annotation is used for creating preliminary annotations.
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Command line interface (CLI)"
|
||||
linkTitle: "CLI"
|
||||
weight: 3
|
||||
title: 'Command line interface (CLI)'
|
||||
linkTitle: 'CLI'
|
||||
weight: 32
|
||||
description: This section on [GitHub](https://github.com/openvinotoolkit/cvat/tree/develop/utils/cli)
|
||||
---
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
---
|
||||
title: 'Formats'
|
||||
linkTitle: 'Formats'
|
||||
weight: 31
|
||||
---
|
||||
|
||||
#### CVAT supported the following formats:
|
||||
|
||||
- [CVAT](format-cvat)
|
||||
- [Datumaro](format-datumaro)
|
||||
- [LabelMe](format-labelme)
|
||||
- [MOT](format-mot)
|
||||
- [MOTS](format-mots)
|
||||
- [COCO](format-coco)
|
||||
- [PASCAL VOC and mask](format-voc)
|
||||
- [YOLO](format-yolo)
|
||||
- [TF detection API](format-tfrecord)
|
||||
- [ImageNet](format-imagenet)
|
||||
- [CamVid](format-camvid)
|
||||
- [WIDER Face](format-widerface)
|
||||
- [VGGFace2](format-vggface2)
|
||||
- [Market-1501](format-market1501)
|
||||
- [ICDAR13/15](format-icdar)
|
||||
@ -1,9 +1,9 @@
|
||||
---
|
||||
linkTitle: "Datumaro"
|
||||
linkTitle: 'Datumaro'
|
||||
weight: 1.5
|
||||
---
|
||||
|
||||
### Datumaro format <a id="datumaro" />
|
||||
# Datumaro format
|
||||
|
||||
[Datumaro](https://github.com/openvinotoolkit/datumaro/) is a tool, which can
|
||||
help with complex dataset and annotation transformations, format conversions,
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Projects"
|
||||
linkTitle: "Projects"
|
||||
weight: 4
|
||||
title: 'Projects'
|
||||
linkTitle: 'Projects'
|
||||
weight: 3
|
||||
---
|
||||
|
||||
At CVAT, you can create a project containing tasks of the same type.
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Review"
|
||||
linkTitle: "Review"
|
||||
weight: 13
|
||||
title: 'Review'
|
||||
linkTitle: 'Review'
|
||||
weight: 22
|
||||
---
|
||||
|
||||
A special mode to check the annotation allows you to point to an object or area in the frame containing an error.
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Search"
|
||||
linkTitle: "Search"
|
||||
weight: 6
|
||||
title: 'Search'
|
||||
linkTitle: 'Search'
|
||||
weight: 2
|
||||
---
|
||||
|
||||
There are several options how to use the search.
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Shape grouping"
|
||||
linkTitle: "Shape grouping"
|
||||
weight: 15
|
||||
title: 'Shape grouping'
|
||||
linkTitle: 'Shape grouping'
|
||||
weight: 21
|
||||
---
|
||||
|
||||
This feature allows us to group several shapes.
|
||||
@ -1,10 +1,10 @@
|
||||
---
|
||||
title: "Shape mode (advanced)"
|
||||
linkTitle: "Shape mode"
|
||||
weight: 1
|
||||
title: 'Shape mode (advanced)'
|
||||
linkTitle: 'Shape mode'
|
||||
weight: 4
|
||||
---
|
||||
|
||||
Basic operations in the mode were described in section [shape mode (basics)](/docs/for-users/user-guide/basics/shape-mode-basics/).
|
||||
Basic operations in the mode were described in section [shape mode (basics)](/docs/manual/basics/shape-mode-basics/).
|
||||
|
||||
**Occluded**
|
||||
Occlusion is an attribute used if an object is occluded by another object or
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Shortcuts"
|
||||
linkTitle: "Shortcuts"
|
||||
weight: 18
|
||||
title: 'Shortcuts'
|
||||
linkTitle: 'Shortcuts'
|
||||
weight: 24
|
||||
---
|
||||
|
||||
Many UI elements have shortcut hints. Put your pointer to a required element to see it.
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Task synchronization with a repository"
|
||||
linkTitle: "Task synchronization"
|
||||
weight: 10
|
||||
title: 'Task synchronization with a repository'
|
||||
linkTitle: 'Task synchronization'
|
||||
weight: 25
|
||||
---
|
||||
|
||||
1. At the end of the annotation process, a task is synchronized by clicking
|
||||
@ -1,10 +1,10 @@
|
||||
---
|
||||
title: "Track mode (advanced)"
|
||||
linkTitle: "Track mode"
|
||||
weight: 2
|
||||
title: 'Track mode (advanced)'
|
||||
linkTitle: 'Track mode'
|
||||
weight: 5
|
||||
---
|
||||
|
||||
Basic operations in the mode were described in section [track mode (basics)](/docs/for-users/user-guide/basics/track-mode-basics/).
|
||||
Basic operations in the mode were described in section [track mode (basics)](/docs/manual/basics/track-mode-basics/).
|
||||
|
||||
Shapes that were created in the track mode, have extra navigation buttons.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: 'XML annotation format'
|
||||
linkTitle: 'XML annotation format'
|
||||
weight: 3
|
||||
weight: 30
|
||||
---
|
||||
|
||||
<!--lint disable heading-style-->
|
||||
@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Basics"
|
||||
linkTitle: "Basics"
|
||||
weight: 1
|
||||
description: 'This section contains basic documents for CVAT users'
|
||||
hide_feedback: true
|
||||
|
||||
---
|
||||
@ -1,9 +1,8 @@
|
||||
---
|
||||
title: "Getting started"
|
||||
linkTitle: "Getting started"
|
||||
title: 'Authorization'
|
||||
linkTitle: 'Authorization'
|
||||
weight: 1
|
||||
---
|
||||
### Authorization
|
||||
|
||||
- First of all, you have to log in to CVAT tool.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Basic navigation"
|
||||
linkTitle: "Basic navigation"
|
||||
weight: 1
|
||||
title: 'Basic navigation'
|
||||
linkTitle: 'Basic navigation'
|
||||
weight: 6
|
||||
---
|
||||
1. Use arrows below to move to the next/previous frame.
|
||||
Use the scroll bar slider to scroll through frames.
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: "Interface of the annotation tool"
|
||||
linkTitle: "Interface"
|
||||
weight: 7
|
||||
title: 'Interface of the annotation tool'
|
||||
linkTitle: 'Interface'
|
||||
weight: 4
|
||||
---
|
||||
The tool consists of:
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue