Skip to content

Commit

Permalink
correct datum project import examples (#1210)
Browse files Browse the repository at this point in the history
<!-- Contributing guide:
https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md
-->

### Summary
1. Correct documents to use correctly use 'datum project import'
command.
2. Add filtering example to filter out items containing annotations
only. (#1208)
<!--
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.​
- [x] I have added the description of my changes into
[CHANGELOG](https://github.com/openvinotoolkit/datumaro/blob/develop/CHANGELOG.md).​
- [x] 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
```
  • Loading branch information
Jihyeon Yi authored Nov 28, 2023
1 parent 231f6d9 commit 27e3804
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
(<https://github.com/openvinotoolkit/datumaro/pull/1195>)
- Fix wrong command to install datumaro from github
(<https://github.com/openvinotoolkit/datumaro/pull/1202>, <https://github.com/openvinotoolkit/datumaro/pull/1207>)
- Update document to correct wrong `datum project import` command and add filtering example to filter out items containing annotations.
(<https://github.com/openvinotoolkit/datumaro/pull/1210>)

## 16/11/2023 - Release 1.5.1
### Enhancements
Expand Down
10 changes: 8 additions & 2 deletions docs/source/docs/command-reference/context_free/filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,14 @@ Example:
Use data only from the "s1" source of the project
```console
datum project create
datum project import --format voc -i <path/to/dataset1/> --name s1
datum project import --format voc -i <path/to/dataset2/> --name s2
datum project import --name s1 --format voc <path/to/dataset1/>
datum project import --name s2 --format voc <path/to/dataset2/>
datum filter s1 \
-m i+a -e '/item/annotation[occluded="False"]'
```

- Extract a dataset composed solely of items containing annotations.
```console
datum filter -e '/item[annotation]'
```
The `item[annotation]` checks if there is a child named `annotation` within the `item` node.
7 changes: 1 addition & 6 deletions docs/source/docs/data-formats/formats/sly_pointcloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,8 @@ Point Cloud dataset directory should have the following structure:
└── meta.json
```

There are two ways to import a Supervisely Point Cloud dataset:
Use the command below to import a Supervisely Point Cloud dataset:

```bash
datum project create
datum project import --format sly_pointcloud --input-path <path/to/dataset>
```
or
``` bash
datum project create
datum project import -f sly_pointcloud <path/to/dataset>
Expand Down

0 comments on commit 27e3804

Please # to comment.