Skip to content

Commit

Permalink
added videos to documentation (#7534)
Browse files Browse the repository at this point in the history
  • Loading branch information
@mdacoca
mdacoca committed Feb 29, 2024
1 parent 9952456 commit 14b592f
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 12 deletions.
31 changes: 19 additions & 12 deletions site/content/en/docs/enterprise/shapes-converter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ See:

- [Run actions menu](#run-actions-menu)
- [Convert shapes](#convert-shapes)
- [Convert shapes video tutorial](#convert-shapes-video-tutorial)

## Run actions menu

Expand All @@ -33,31 +34,29 @@ With the following fields:

<!--lint disable maximum-line-length-->

| Field | Description |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Field | Description |
| ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Select action** | Drop-down list with available actions: <br><li>**Remove filtered shapes** - removes all shapes in alignment with the set-up filter. Doesn't work with tracks.</li><li>**Shapes converter: masks to polygons** - converts all masks to polygons.</li><li>**Shapes converter: masks to rectangles** - converts all masks to rectangles in alignment with the set-up filter.</li><li>**Shapes converter: polygon to masks** - converts all polygons to masks.</li><li>**Shapes converter: polygon to rectangles** - converts all polygons to rectangles.</li><li>**Shapes converter: rectangles to masks** - converts all rectangles to masks.</li><li>**Shapes converter: rectangles to polygons** - converts all rectangles to polygons.</li><br>**Note:** only **Remove filtered shapes** is available on the **Free** plan. |
| **Specify frames to run action** | Field where you can specify the frame range for the selected action. Enter the starting frame in the **Starting from frame:** field, and the ending frame in the **up to frame** field. <br><br>If nothing is selected here or in **Choose one of the predefined options** section, the action will be applied to all fields. |
| **Choose one of the predefined options** | Predefined options to apply to frames. Selection here is mutually exclusive with **Specify frames to run action**. <br><br>If nothing is selected here or in **Specify frames to run action** section, the action will be applied to all fields. |
| **Specify frames to run action** | Field where you can specify the frame range for the selected action. Enter the starting frame in the **Starting from frame:** field, and the ending frame in the **up to frame** field. <br><br>If nothing is selected here or in **Choose one of the predefined options** section, the action will be applied to all fields. |
| **Choose one of the predefined options** | Predefined options to apply to frames. Selection here is mutually exclusive with **Specify frames to run action**. <br><br>If nothing is selected here or in **Specify frames to run action** section, the action will be applied to all fields. |

<!--lint enable maximum-line-length-->



## Convert shapes

**Recommended Precautions Before Running Annotation Actions**

- **Saving changes:** It is recommended to save all changes prior to initiating the annotation action.
If unsaved changes are detected, a prompt will advise to save these changes
to avoid any potential loss of data.
If unsaved changes are detected, a prompt will advise to save these changes
to avoid any potential loss of data.

- **Disabу auto-save:** Prior to running the annotation action, disabling the auto-save feature
is advisable. A notification will suggest this action if auto-save is currently active.
is advisable. A notification will suggest this action if auto-save is currently active.

- **Committing changes:** Changes applied during the annotation session
will not be committed to the server until the saving process is manually
initiated. This can be done either by the user or through the
auto-save feature, should it be enabled.
will not be committed to the server until the saving process is manually
initiated. This can be done either by the user or through the
auto-save feature, should it be enabled.

To convert shapes, do the following:

Expand All @@ -79,3 +78,11 @@ To convert shapes, do the following:
![](/images/shapes-coverter-action-run.jpg)

> **Note:** Once the action is applied, it cannot be undone.
## Convert shapes video tutorial

<!--lint disable maximum-line-length-->

<iframe width="560" height="315" src="https://www.youtube.com/embed/sAVEdjmw0C0?si=ZhRuwdAMSNrdieBp" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

<!--lint enable maximum-line-length-->
10 changes: 10 additions & 0 deletions site/content/en/docs/manual/advanced/annotation-with-ellipses.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,13 @@ to complete the shape.

You can rotate ellipses using a rotation point in the same way as
[rectangles](/docs/manual/advanced/annotation-with-rectangles/#rotation-rectangle).

## Annotation with ellipses video tutorial


<!--lint disable maximum-line-length-->

<iframe width="560" height="315" src="https://www.youtube.com/embed/jmwtePYCz94?si=wbfYEX4pzGziXf1Y" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

<!--lint enable maximum-line-length-->

8 changes: 8 additions & 0 deletions site/content/en/docs/manual/advanced/shape-grouping.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,11 @@ Shapes that don't have `group_id`, will be highlighted in white.
![](/images/image078_detrac.jpg)

![](/images/image077_detrac.jpg)

## Shapes grouping video tutorial

<!--lint disable maximum-line-length-->

<iframe width="560" height="315" src="https://www.youtube.com/embed/m8bB9f23wLs?si=N5EzIRG-1Wn6R15G" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

<!--lint enable maximum-line-length-->

0 comments on commit 14b592f

Please sign in to comment.