Skip to content

Commit c5911ea

Browse files
authored
Fix documentation links (#972)
<!-- Contributing guide: https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md --> ### Summary - Fix broken documentation links <!-- Resolves #111 and #222. Depends on #1000 (for series of dependent commits). This PR introduces this capability to make the project better in this and that. - Added this feature - Removed that feature - Fixed the problem #1234 --> ### How to test <!-- Describe the testing procedure for reviewers, if changes are not fully covered by unit tests or manual testing can be complicated. --> ### Checklist <!-- Put an 'x' in all the boxes that apply --> - [ ] I have added unit tests to cover my changes.​ - [ ] I have added integration tests to cover my changes.​ - [ ] I have added the description of my changes into [CHANGELOG](https://github.com/openvinotoolkit/datumaro/blob/develop/CHANGELOG.md).​ - [ ] I have updated the [documentation](https://github.com/openvinotoolkit/datumaro/tree/develop/docs) accordingly ### License - [ ] I submit _my code changes_ under the same [MIT License](https://github.com/openvinotoolkit/datumaro/blob/develop/LICENSE) that covers the project. Feel free to contact the maintainers if that's a concern. - [ ] I have updated the license header for each file (see an example below). ```python # Copyright (C) 2023 Intel Corporation # # SPDX-License-Identifier: MIT ```
1 parent 769c620 commit c5911ea

File tree

8 files changed

+16
-15
lines changed

8 files changed

+16
-15
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,11 @@ CVAT annotations ---> Publication, statistics etc.
1515
```
1616
<!--lint enable fenced-code-flag-->
1717

18-
- [Getting started](https://openvinotoolkit.github.io/datumaro/docs/getting_started)
18+
- [Getting started](https://openvinotoolkit.github.io/datumaro/latest/docs/get-started/quick-start-guide)
19+
- [Level Up](https://openvinotoolkit.github.io/datumaro/latest/docs/level-up/basic_skills)
1920
- [Features](#features)
20-
- [User manual](https://openvinotoolkit.github.io/datumaro/docs/user-manual)
21-
- [Developer manual](https://openvinotoolkit.github.io/datumaro/api)
21+
- [User manual](https://openvinotoolkit.github.io/datumaro/latest/docs/user-manual/how_to_use_datumaro)
22+
- [Developer manual](https://openvinotoolkit.github.io/datumaro/latest/docs/reference/datumaro/datumaro)
2223
- [Contributing](#contributing)
2324

2425
## Features
@@ -45,7 +46,7 @@ CVAT annotations ---> Publication, statistics etc.
4546
(`bboxes`, `masks`)
4647
- [YOLO](https://github.com/AlexeyAB/darknet#how-to-train-pascal-voc-data) (`bboxes`)
4748

48-
Other formats and documentation for them can be found [here](https://openvinotoolkit.github.io/datumaro/docs/user-manual/supported_formats).
49+
Other formats and documentation for them can be found [here](https://openvinotoolkit.github.io/datumaro/latest/docs/data-formats/supported_formats).
4950
- Dataset building
5051
- Merging multiple datasets into one
5152
- Dataset filtering by a custom criteria:
@@ -85,10 +86,10 @@ CVAT annotations ---> Publication, statistics etc.
8586
- RISE for object detection
8687

8788
> Check
88-
[the design document](https://openvinotoolkit.github.io/datumaro/docs/design)
89+
[the design document](https://openvinotoolkit.github.io/datumaro/latest/docs/explanation/architecture)
8990
for a full list of features.
9091
> Check
91-
[the user manual](https://openvinotoolkit.github.io/datumaro/docs/user-manual)
92+
[the user manual](https://openvinotoolkit.github.io/datumaro/latest/docs/user-manual/how_to_use_datumaro)
9293
for usage instructions.
9394

9495
## Contributing
@@ -99,12 +100,12 @@ Feel free to
99100
[open an Issue](https://github.com/openvinotoolkit/datumaro/issues/new), if you
100101
think something needs to be changed. You are welcome to participate in
101102
development, instructions are available in our
102-
[contribution guide](https://openvinotoolkit.github.io/datumaro/docs/contributing).
103+
[contribution guide](https://github.com/openvinotoolkit/datumaro/blob/develop/contributing.md).
103104

104105
## Telemetry data collection note
105106

106107
The [OpenVINO™ telemetry library](https://github.com/openvinotoolkit/telemetry/)
107108
is used to collect basic information about Datumaro usage.
108109

109110
To enable/disable telemetry data collection please see the
110-
[guide](https://openvinotoolkit.github.io/datumaro/docs/user-manual/how_to_control_tm_data_collection/).
111+
[guide](https://openvinotoolkit.github.io/datumaro/latest/docs/user-manual/how_to_control_tm_data_collection).

datumaro/cli/util/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ def show_video_import_warning():
107107
"system setup changes (library version, OS, etc.). "
108108
"If you need stable results, consider splitting the video "
109109
"manually using instructions at: "
110-
"https://openvinotoolkit.github.io/datumaro/docs/media_formats/"
110+
"https://openvinotoolkit.github.io/datumaro/latest/docs/data-formats/media_formats"
111111
)
112112

113113

docs/source/docs/get-started/introduction.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Datumaro supports the following features:
4343
(`bboxes`, `masks`)
4444
- `YOLO <https://github.com/AlexeyAB/darknet#how-to-train-pascal-voc-data>`_ (`bboxes`)
4545

46-
Other formats and documentation for them can be found `here <https://openvinotoolkit.github.io/datumaro/docs/user-manual/supported_formats>`_.
46+
Other formats and documentation for them can be found `here <https://openvinotoolkit.github.io/datumaro/latest/docs/data-formats/supported_formats>`_.
4747
- Dataset building
4848

4949
- Merging multiple datasets into one

notebooks/06_tiling.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
" ├── ...\n",
3333
"```\n",
3434
"\n",
35-
"However, for import compatibility, `obj.names` file must be added to `d6-dice/obj.names` filepath for import compatibility. This `obj.names` file includes the label names of the dataset, e.g., `[dice1, ..., dice6]`. Therefore, you can write it with the following simple code. Please see [Yolo Loose format](https://openvinotoolkit.github.io/datumaro/docs/formats/yolo/) for more details."
35+
"However, for import compatibility, `obj.names` file must be added to `d6-dice/obj.names` filepath for import compatibility. This `obj.names` file includes the label names of the dataset, e.g., `[dice1, ..., dice6]`. Therefore, you can write it with the following simple code. Please see [Yolo Loose format](https://openvinotoolkit.github.io/datumaro/latest/docs/explanation/formats/yolo) for more details."
3636
]
3737
},
3838
{

notebooks/08_e2e_example_yolo_ultralytics_trainer.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
" ├── ...\n",
2424
"```\n",
2525
"\n",
26-
"However, for import compatibility, `obj.names` file must be added to `d6-dice/obj.names` filepath for import compatibility. This `obj.names` file includes the label names of the dataset, e.g., `[dice1, ..., dice6]`. Therefore, you can write it with the following simple code. Please see [Yolo Loose format](https://openvinotoolkit.github.io/datumaro/docs/formats/yolo/) for more details."
26+
"However, for import compatibility, `obj.names` file must be added to `d6-dice/obj.names` filepath for import compatibility. This `obj.names` file includes the label names of the dataset, e.g., `[dice1, ..., dice6]`. Therefore, you can write it with the following simple code. Please see [Yolo Loose format](https://openvinotoolkit.github.io/datumaro/latest/docs/explanation/formats/yolo) for more details."
2727
]
2828
},
2929
{

notebooks/09_encrypt_dataset.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
" ├── ...\n",
2424
"```\n",
2525
"\n",
26-
"However, for import compatibility, `obj.names` file must be added to `d6-dice/obj.names` filepath for import compatibility. This `obj.names` file includes the label names of the dataset, e.g., `[dice1, ..., dice6]`. Therefore, you can write it with the following simple code. Please see [Yolo Loose format](https://openvinotoolkit.github.io/datumaro/docs/formats/yolo/) for more details."
26+
"However, for import compatibility, `obj.names` file must be added to `d6-dice/obj.names` filepath for import compatibility. This `obj.names` file includes the label names of the dataset, e.g., `[dice1, ..., dice6]`. Therefore, you can write it with the following simple code. Please see [Yolo Loose format](https://openvinotoolkit.github.io/datumaro/latest/docs/explanation/formats/yolo) for more details."
2727
]
2828
},
2929
{

notebooks/10_noisy_label_detection.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@
213213
"source": [
214214
"## Import statistics and analyze them to find the noisy label samples\n",
215215
"\n",
216-
"In this step, we import the statistics obtained during the model training to find the noisy label samples. Because we set the output directory as `outputs` in the previous step, we you can find the dataset including statistics which is exported to [Datumaro format](https://openvinotoolkit.github.io/datumaro/docs/formats/datumaro/) at `outputs/logs/noisy_label_detection`. To make training loss dynamics analysis easier, we provide an interface called `dm.LossDynamicsAnalyzer`. You can get the top-k candidates for noisy label samples using it. Additionally, we can also plot the exponential moving average (EMA) training loss curves of top-k candidates and compare them with the average of samples in the dataset. The EMA training loss is a very strong criterion for noisy label samples. For more detail, please see [1].\n",
216+
"In this step, we import the statistics obtained during the model training to find the noisy label samples. Because we set the output directory as `outputs` in the previous step, we you can find the dataset including statistics which is exported to [Datumaro format](https://openvinotoolkit.github.io/datumaro/latest/docs/explanation/formats/datumaro) at `outputs/logs/noisy_label_detection`. To make training loss dynamics analysis easier, we provide an interface called `dm.LossDynamicsAnalyzer`. You can get the top-k candidates for noisy label samples using it. Additionally, we can also plot the exponential moving average (EMA) training loss curves of top-k candidates and compare them with the average of samples in the dataset. The EMA training loss is a very strong criterion for noisy label samples. For more detail, please see [1].\n",
217217
"\n",
218218
"[1]: Zhou, Tianyi, Shengjie Wang, and Jeff Bilmes. \"Robust curriculum learning: from clean label detection to noisy label self-correction.\" International Conference on Learning Representations. 2021."
219219
]

notebooks/11_validate.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
"source": [
88
"# Validate datasets\n",
99
"\n",
10-
"In this notebook example, we are going to generate the validation report, which contains types of anomaly data regarding to https://openvinotoolkit.github.io/datumaro/docs/user-manual/command-reference/validate. Through this, we can identify which data was inapplicable for DL workflow because it is broken or undefined. Moreover, we detect imbalanced, out-of-distributed, or rare samples together.\n",
10+
"In this notebook example, we are going to generate the validation report, which contains types of anomaly data regarding to https://openvinotoolkit.github.io/datumaro/latest/docs/command-reference/context_free/validate. Through this, we can identify which data was inapplicable for DL workflow because it is broken or undefined. Moreover, we detect imbalanced, out-of-distributed, or rare samples together.\n",
1111
"\n",
1212
"## Prerequisite \n",
1313
"### Download COCO 2017 validation dataset \n",

0 commit comments

Comments
 (0)