Skip to content

Commit a867b9a

Browse files
authored
Update documentation and references to Open-Edge Platform (#4331)
* Update documentation and references to Open-Edge Platform- Updated dataset format links in auto_configuration.rst, models_optimization.rst, and various algorithm documentation to point to the Open-Edge Platform repository. - Changed references from openvinotoolkit to open-edge-platform in multiple files including anomaly detection, classification, object detection, segmentation, and product design documentation. - Modified installation instructions and CLI command references to reflect the new repository URL. - Adjusted the help formatter to display the updated GitHub repository link. - Ensured all links to Datumaro and related resources are consistent with the new repository structure.
1 parent 51ec6bb commit a867b9a

File tree

27 files changed

+94
-94
lines changed

27 files changed

+94
-94
lines changed

.ci/docker/start-runner.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -185,7 +185,7 @@ echo "Successfully started ci container - $CONTAINER_NAME"
185185
docker exec -it "$CONTAINER_NAME" bash -c \
186186
"./actions-runner/config.sh \
187187
--unattended \
188-
--url https://github.com/openvinotoolkit/training_extensions \
188+
--url https://github.com/open-edge-platform/training_extensions \
189189
--token $GITHUB_TOKEN \
190190
--name $CONTAINER_NAME \
191191
--labels $LABELS \

.github/pull_request_template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ not fully covered by unit tests or manual testing can be complicated. -->
2323
- [ ] I have added unit tests to cover my changes.​
2424
- [ ] I have added integration tests to cover my changes.​
2525
- [ ] I have ran e2e tests and there is no issues.
26-
- [ ] I have added the description of my changes into CHANGELOG in my target branch (e.g., [CHANGELOG](https://github.com/openvinotoolkit/training_extensions/blob/develop/CHANGELOG.md) in develop).​
27-
- [ ] I have updated the documentation in my target branch accordingly (e.g., [documentation](https://github.com/openvinotoolkit/training_extensions/tree/develop/docs) in develop).
26+
- [ ] I have added the description of my changes into CHANGELOG in my target branch (e.g., [CHANGELOG](https://github.com/open-edge-platform/training_extensions/blob/develop/CHANGELOG.md) in develop).​
27+
- [ ] I have updated the documentation in my target branch accordingly (e.g., [documentation](https://github.com/open-edge-platform/training_extensions/tree/develop/docs) in develop).
2828
- [ ] I have [linked related issues](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword).
2929

3030
### License
3131

32-
- [ ] I submit _my code changes_ under the same [Apache License](https://github.com/openvinotoolkit/training_extensions/blob/develop/LICENSE) that covers the project.
32+
- [ ] I submit _my code changes_ under the same [Apache License](https://github.com/open-edge-platform/training_extensions/blob/develop/LICENSE) that covers the project.
3333
Feel free to contact the maintainers if that's a concern.
3434
- [ ] I have updated the license header for each file (see an example below).
3535

.github/workflows/perf_benchmark.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ on:
5050
type: string
5151
description: |
5252
Target OTX ref (tag / branch name / commit hash) on main repo to test. Defaults to the current branch.
53-
`pip install otx[full]@https://github.com/openvinotoolkit/training_extensions.git@{otx_ref}` will be executed before run,
53+
`pip install otx[full]@https://github.com/open-edge-platform/training_extensions.git@{otx_ref}` will be executed before run,
5454
and reverted after run. Works only for v2.x assuming CLI compatibility.
5555
default: __CURRENT_BRANCH_COMMIT__
5656
workflow_call:
@@ -89,7 +89,7 @@ on:
8989
type: string
9090
description: |
9191
Target OTX ref (tag / branch name / commit hash) on main repo to test. Defaults to the current branch.
92-
`pip install otx[full]@https://github.com/openvinotoolkit/training_extensions.git@{otx_ref}` will be executed before run,
92+
`pip install otx[full]@https://github.com/open-edge-platform/training_extensions.git@{otx_ref}` will be executed before run,
9393
and reverted after run. Works only for v2.x assuming CLI compatibility.
9494
default: __CURRENT_BRANCH_COMMIT__
9595

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
---
66

77
[Key Features](#key-features)
8-
[Installation](https://openvinotoolkit.github.io/training_extensions/latest/guide/get_started/installation.html)
9-
[Documentation](https://openvinotoolkit.github.io/training_extensions/latest/index.html)
8+
[Installation](https://open-edge-platform.github.io/training_extensions/latest/guide/get_started/installation.html)
9+
[Documentation](https://open-edge-platform.github.io/training_extensions/latest/index.html)
1010
[License](#license)
1111

1212
[![PyPI](https://img.shields.io/pypi/v/otx)](https://pypi.org/project/otx)
@@ -19,10 +19,10 @@
1919

2020
<!-- markdownlint-enable MD042 -->
2121

22-
[![Codecov](https://codecov.io/gh/openvinotoolkit/training_extensions/branch/develop/graph/badge.svg?token=9HVFNMPFGD)](https://codecov.io/gh/openvinotoolkit/training_extensions)
23-
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/openvinotoolkit/training_extensions/badge)](https://securityscorecards.dev/viewer/?uri=github.com/openvinotoolkit/training_extensions)
24-
[![Pre-Merge Test](https://github.com/openvinotoolkit/training_extensions/actions/workflows/pre_merge.yaml/badge.svg)](https://github.com/openvinotoolkit/training_extensions/actions/workflows/pre_merge.yaml)
25-
[![Build Docs](https://github.com/openvinotoolkit/training_extensions/actions/workflows/docs.yaml/badge.svg)](https://github.com/openvinotoolkit/training_extensions/actions/workflows/docs.yaml)
22+
[![Codecov](https://codecov.io/gh/open-edge-platform/training_extensions/branch/develop/graph/badge.svg?token=9HVFNMPFGD)](https://codecov.io/gh/open-edge-platform/training_extensions)
23+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/open-edge-platform/training_extensions/badge)](https://securityscorecards.dev/viewer/?uri=github.com/open-edge-platform/training_extensions)
24+
[![Pre-Merge Test](https://github.com/open-edge-platform/training_extensions/actions/workflows/pre_merge.yaml/badge.svg)](https://github.com/open-edge-platform/training_extensions/actions/workflows/pre_merge.yaml)
25+
[![Build Docs](https://github.com/open-edge-platform/training_extensions/actions/workflows/docs.yaml/badge.svg)](https://github.com/open-edge-platform/training_extensions/actions/workflows/docs.yaml)
2626
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2727
[![Downloads](https://static.pepy.tech/personalized-badge/otx?period=total&units=international_system&left_color=grey&right_color=green&left_text=PyPI%20Downloads)](https://pepy.tech/project/otx)
2828

@@ -42,7 +42,7 @@ If you are an experienced user, you can configure your own model based on [torch
4242

4343
Furthermore, OpenVINO™ Training Extensions provides automatic configuration for ease of use.
4444
The framework will analyze your dataset and identify the most suitable model and figure out the best input size setting and other hyper-parameters.
45-
The development team is continuously extending this [Auto-configuration](https://openvinotoolkit.github.io/training_extensions/latest/guide/explanation/additional_features/auto_configuration.html) functionalities to make training as simple as possible so that single CLI command can obtain accurate, efficient and robust models ready to be integrated into your project.
45+
The development team is continuously extending this [Auto-configuration](https://open-edge-platform.github.io/training_extensions/latest/guide/explanation/additional_features/auto_configuration.html) functionalities to make training as simple as possible so that single CLI command can obtain accurate, efficient and robust models ready to be integrated into your project.
4646

4747
### Key Features
4848

@@ -54,22 +54,22 @@ OpenVINO™ Training Extensions supports the following computer vision tasks:
5454
- **Instance segmentation** including tiling algorithm support
5555
- **Anomaly recognition** tasks including anomaly classification, detection and segmentation
5656

57-
OpenVINO™ Training Extensions supports the [following learning methods](https://openvinotoolkit.github.io/training_extensions/latest/guide/explanation/algorithms/index.html):
57+
OpenVINO™ Training Extensions supports the [following learning methods](https://open-edge-platform.github.io/training_extensions/latest/guide/explanation/algorithms/index.html):
5858

5959
- **Supervised**, incremental training, which includes class incremental scenario.
6060

6161
OpenVINO™ Training Extensions provides the following usability features:
6262

63-
- [Auto-configuration](https://openvinotoolkit.github.io/training_extensions/latest/guide/explanation/additional_features/auto_configuration.html). OpenVINO™ Training Extensions analyzes provided dataset and selects the proper task and model to provide the best accuracy/speed trade-off.
64-
- [Datumaro](https://openvinotoolkit.github.io/datumaro/stable/index.html) data frontend: OpenVINO™ Training Extensions supports the most common academic field dataset formats for each task. We are constantly working to extend supported formats to give more freedom of datasets format choice.
63+
- [Auto-configuration](https://open-edge-platform.github.io/training_extensions/latest/guide/explanation/additional_features/auto_configuration.html). OpenVINO™ Training Extensions analyzes provided dataset and selects the proper task and model to provide the best accuracy/speed trade-off.
64+
- [Datumaro](https://open-edge-platform.github.io/datumaro/stable/index.html) data frontend: OpenVINO™ Training Extensions supports the most common academic field dataset formats for each task. We are constantly working to extend supported formats to give more freedom of datasets format choice.
6565
- **Distributed training** to accelerate the training process when you have multiple GPUs
6666
- **Mixed-precision training** to save GPUs memory and use larger batch sizes
6767

6868
---
6969

7070
## Installation
7171

72-
Please refer to the [installation guide](https://openvinotoolkit.github.io/training_extensions/latest/guide/get_started/installation.html).
72+
Please refer to the [installation guide](https://open-edge-platform.github.io/training_extensions/latest/guide/get_started/installation.html).
7373
If you want to make changes to the library, then a local installation is recommended.
7474

7575
<details>
@@ -102,7 +102,7 @@ conda activate otx_env
102102
# ...
103103

104104
# Clone the repository and install in editable mode
105-
git clone https://github.com/openvinotoolkit/training_extensions.git
105+
git clone https://github.com/open-edge-platform/training_extensions.git
106106
cd training_extensions
107107
pip install -e .[base] # for zsh: pip install -e '.[base]'
108108
```
@@ -129,7 +129,7 @@ otx train --help -v # Print required parameters
129129
otx train --help -vv # Print all configurable parameters
130130
```
131131

132-
You can find details with examples in the [CLI Guide](https://openvinotoolkit.github.io/training_extensions/latest/guide/get_started/cli_commands.html). and [API Quick-Guide](https://openvinotoolkit.github.io/training_extensions/latest/guide/get_started/api_tutorial.html).
132+
You can find details with examples in the [CLI Guide](https://open-edge-platform.github.io/training_extensions/latest/guide/get_started/cli_commands.html). and [API Quick-Guide](https://open-edge-platform.github.io/training_extensions/latest/guide/get_started/api_tutorial.html).
133133

134134
Below is how to train with auto-configuration, which is provided to users with datasets and tasks:
135135

@@ -144,7 +144,7 @@ engine = Engine(data_root="data/wgisd", task="DETECTION")
144144
engine.train()
145145
```
146146

147-
For more examples, see documentation: [API Quick-Guide](https://openvinotoolkit.github.io/training_extensions/latest/guide/get_started/api_tutorial.html)
147+
For more examples, see documentation: [API Quick-Guide](https://open-edge-platform.github.io/training_extensions/latest/guide/get_started/api_tutorial.html)
148148

149149
</details>
150150

@@ -155,11 +155,11 @@ For more examples, see documentation: [API Quick-Guide](https://openvinotoolkit.
155155
otx train --data_root data/wgisd --task DETECTION
156156
```
157157

158-
For more examples, see documentation: [CLI Guide](https://openvinotoolkit.github.io/training_extensions/latest/guide/get_started/cli_commands.html)
158+
For more examples, see documentation: [CLI Guide](https://open-edge-platform.github.io/training_extensions/latest/guide/get_started/cli_commands.html)
159159

160160
</details>
161161

162-
In addition to the examples above, please refer to the documentation for tutorials on using custom models, training parameter overrides, and [tutorial per task types](https://openvinotoolkit.github.io/training_extensions/latest/guide/tutorials/base/how_to_train/index.html), etc.
162+
In addition to the examples above, please refer to the documentation for tutorials on using custom models, training parameter overrides, and [tutorial per task types](https://open-edge-platform.github.io/training_extensions/latest/guide/tutorials/base/how_to_train/index.html), etc.
163163

164164
---
165165

@@ -178,7 +178,7 @@ By contributing to the project, you agree to the license and copyright terms the
178178

179179
## Issues / Discussions
180180

181-
Please use [Issues](https://github.com/openvinotoolkit/training_extensions/issues/new/choose) tab for your bug reporting, feature requesting, or any questions.
181+
Please use [Issues](https://github.com/open-edge-platform/training_extensions/issues/new/choose) tab for your bug reporting, feature requesting, or any questions.
182182

183183
---
184184

@@ -196,8 +196,8 @@ For those who would like to contribute to the library, see [CONTRIBUTING.md](CON
196196

197197
Thank you! we appreciate your support!
198198

199-
<a href="https://github.com/openvinotoolkit/training_extensions/graphs/contributors">
200-
<img src="https://contrib.rocks/image?repo=openvinotoolkit/training_extensions" />
199+
<a href="https://github.com/open-edge-platform/training_extensions/graphs/contributors">
200+
<img src="https://contrib.rocks/image?repo=open-edge-platform/training_extensions" />
201201
</a>
202202

203203
---

docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
1. By executing the following commands, it will build two Docker images: `otx:${OTX_VERSION}-cuda` and `otx:${OTX_VERSION}-cuda-pretrained-ready`.
44

55
```console
6-
git clone https://github.com/openvinotoolkit/training_extensions.git
6+
git clone https://github.com/open-edge-platform/training_extensions.git
77
cd docker
88
./build.sh
99
```

docs/source/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@
101101
"icon_links": [
102102
{
103103
"name": "GitHub",
104-
"url": "https://github.com/openvinotoolkit/training_extensions",
104+
"url": "https://github.com/open-edge-platform/training_extensions",
105105
"icon": "fab fa-github",
106106
"type": "fontawesome",
107107
},
@@ -113,7 +113,7 @@
113113
}
114114

115115
html_context = {
116-
"github_user": "openvinotoolkit",
116+
"github_user": "open-edge-platform",
117117
"github_repo": "training_extensions",
118118
"github_version": "master",
119119
"doc_path": "docs/source/",

docs/source/guide/explanation/additional_features/auto_configuration.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ After dataset preparation, the training will be started with the middle-sized re
3939
Supported dataset formats for each task:
4040

4141
- classification: `Imagenet <https://www.image-net.org/>`_, `COCO <https://cocodataset.org/#format-data>`_ (multi-label), :ref:`custom hierarchical <hierarchical_dataset>`
42-
- object detection: `COCO <https://cocodataset.org/#format-data>`_, `Pascal-VOC <https://openvinotoolkit.github.io/datumaro/stable/docs/data-formats/formats/pascal_voc.html>`_, `YOLO <https://openvinotoolkit.github.io/datumaro/stable/docs/data-formats/formats/yolo.html>`_
43-
- semantic segmentation: `Common Semantic Segmentation <https://openvinotoolkit.github.io/datumaro/stable/docs/data-formats/formats/common_semantic_segmentation.html>`_, `Pascal-VOC <https://openvinotoolkit.github.io/datumaro/stable/docs/data-formats/formats/pascal_voc.html>`_, `Cityscapes <https://openvinotoolkit.github.io/datumaro/stable/docs/data-formats/formats/cityscapes.html>`_, `ADE20k <https://openvinotoolkit.github.io/datumaro/stable/docs/data-formats/formats/ade20k2020.html>`_
42+
- object detection: `COCO <https://cocodataset.org/#format-data>`_, `Pascal-VOC <https://open-edge-platform.github.io/datumaro/stable/docs/data-formats/formats/pascal_voc.html>`_, `YOLO <https://open-edge-platform.github.io/datumaro/stable/docs/data-formats/formats/yolo.html>`_
43+
- semantic segmentation: `Common Semantic Segmentation <https://open-edge-platform.github.io/datumaro/stable/docs/data-formats/formats/common_semantic_segmentation.html>`_, `Pascal-VOC <https://open-edge-platform.github.io/datumaro/stable/docs/data-formats/formats/pascal_voc.html>`_, `Cityscapes <https://open-edge-platform.github.io/datumaro/stable/docs/data-formats/formats/cityscapes.html>`_, `ADE20k <https://open-edge-platform.github.io/datumaro/stable/docs/data-formats/formats/ade20k2020.html>`_
4444
- anomaly: `MVTec <https://www.mvtec.com/company/research/datasets/mvtec-ad>`_
45-
- instance segmentation: `COCO <https://cocodataset.org/#format-data>`_, `Pascal-VOC <https://openvinotoolkit.github.io/datumaro/stable/docs/data-formats/formats/pascal_voc.html>`_
45+
- instance segmentation: `COCO <https://cocodataset.org/#format-data>`_, `Pascal-VOC <https://open-edge-platform.github.io/datumaro/stable/docs/data-formats/formats/pascal_voc.html>`_
4646
- keypoint detection: `COCO <https://cocodataset.org/#format-data>`_
4747

4848
If we have a dataset format occluded with other tasks, for example ``COCO`` format, we should directly emphasize the task type. If not, OpenVINO™ Training Extensions automatically chooses the task type that you might not intend:

docs/source/guide/explanation/algorithms/anomaly/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ As mentioned above, the goal of visual anomaly detection is to learn a represent
8080
+--------+-------------------------------------------------------------------------------------------------------------------+----------------------+-----------------+
8181
| Name | Recipe | Complexity (GFLOPs) | Model size (MB) |
8282
+========+===================================================================================================================+======================+=================+
83-
| PADIM | `padim <https://github.com/openvinotoolkit/training_extensions/blob/develop/src/otx/recipe/anomaly_/padim.yaml>`_ | 3.9 | 168.4 |
83+
| PADIM | `padim <https://github.com/open-edge-platform/training_extensions/blob/develop/src/otx/recipe/anomaly_/padim.yaml>`_ | 3.9 | 168.4 |
8484
+--------+-------------------------------------------------------------------------------------------------------------------+----------------------+-----------------+
85-
| STFPM | `stfpm <https://github.com/openvinotoolkit/training_extensions/blob/develop/src/otx/recipe/anomaly_/stfpm.yaml>`_ | 5.6 | 21.1 |
85+
| STFPM | `stfpm <https://github.com/open-edge-platform/training_extensions/blob/develop/src/otx/recipe/anomaly_/stfpm.yaml>`_ | 5.6 | 21.1 |
8686
+--------+-------------------------------------------------------------------------------------------------------------------+----------------------+-----------------+
87-
| U-Flow | `uflow <https://github.com/openvinotoolkit/training_extensions/blob/develop/src/otx/recipe/anomaly_/uflow.yaml>`_ | 59.6 | 62.88 |
87+
| U-Flow | `uflow <https://github.com/open-edge-platform/training_extensions/blob/develop/src/otx/recipe/anomaly_/uflow.yaml>`_ | 59.6 | 62.88 |
8888
+--------+-------------------------------------------------------------------------------------------------------------------+----------------------+-----------------+
8989

9090

docs/source/guide/explanation/algorithms/classification/hierarhical_classification.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ Dataset Format
3838
**************
3939
.. _hierarchical_dataset:
4040

41-
For hierarchical image classification, we created our custom dataset format that is supported by `Datumaro <https://github.com/openvinotoolkit/datumaro>`_.
42-
An example of the annotations format and dataset structure can be found in our `sample <https://github.com/openvinotoolkit/training_extensions/tree/develop/tests/assets/hlabel_classification>`_.
41+
For hierarchical image classification, we created our custom dataset format that is supported by `Datumaro <https://github.com/open-edge-platform/datumaro>`_.
42+
An example of the annotations format and dataset structure can be found in our `sample <https://github.com/open-edge-platform/training_extensions/tree/develop/tests/assets/hlabel_classification>`_.
4343

4444
.. note::
4545

0 commit comments

Comments
 (0)