[WIP] Add new docs with Sphinx (.md)#885
Closed
chuneuny-emily wants to merge 23 commits intodevelopfrom
Closed
Conversation
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## develop #885 +/- ##
===========================================
- Coverage 78.49% 78.49% -0.01%
===========================================
Files 206 206
Lines 24939 24939
Branches 5007 5007
===========================================
- Hits 19577 19575 -2
- Misses 4236 4237 +1
- Partials 1126 1127 +1
Flags with carried forward coverage won't be shown. Click here to find out more. see 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
chuneuny-emily
added
doc
wonjuleee
reviewed
Mar 23, 2023
wonjuleee
reviewed
Mar 23, 2023
| datum export --format tf_detection_api -- --save-images | ||
|
|
||
| - Annotate MS COCO dataset, extract image subset, re-annotate it in | ||
| `CVAT <https://github.com/openvinotoolkit/cvat>`_, update old dataset: |
Contributor
There was a problem hiding this comment.
we may be possible to remove re-annotate part in CVAT
Contributor
Author
There was a problem hiding this comment.
Is there a reason you want to delete the re-annotate part? It explains how to update the new annotation in Datumaro, and I think it's good to have one. e.g., datum project update reannotation-upd
wonjuleee
reviewed
Mar 23, 2023
Contributor
wonjuleee
left a comment
wonjuleee
left a comment
There was a problem hiding this comment.
We agreed to merge the doc-related PRs to docs-rework branch first, don't we?
vinnamkim
reviewed
Mar 23, 2023
docs/source/docs/get-started/quick-start-guide/installation.rst
Outdated
Show resolved
Hide resolved
docs/source/docs/reference/jupyter_notebook_examples/generate.rst
Outdated
Show resolved
Hide resolved
docs/source/docs/reference/jupyter_notebook_examples/filter.rst
Outdated
Show resolved
Hide resolved
docs/source/docs/reference/jupyter_notebook_examples/transform.rst
Outdated
Show resolved
Hide resolved
docs/source/docs/reference/jupyter_notebook_examples/validate.rst
Outdated
Show resolved
Hide resolved
docs/source/docs/reference/jupyter_notebook_examples/visualizer.rst
Outdated
Show resolved
Hide resolved
Contributor
Author
Yes, but the work in the form of the previous copy was already in progress there, so I got confused and took a branch again from the latest develop. You can also delete the existing docs-rework branch and rename it to that one. |
chuneuny-emily
changed the title
chuneuny-emily
changed the title
To exclude 'tab-in-indent' error from whitespace checking on Makefile
…into sphinx-docs-rework
…it/datumaro into sphinx-docs-rework
<!-- Contributing guide: https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md --> ### Summary  <!-- 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 ```
<!-- Contributing guide: https://github.com/openvinotoolkit/datumaro/blob/develop/CONTRIBUTING.md --> ### Summary <!-- 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 ```
Contributor
|
Changes reviewed on the PR was applied #917 and merged. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR contain the restructured documentation with Sphinx.
How to test
Checklist
License
Feel free to contact the maintainers if that's a concern.