Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Docs] Add tutorial of dataset #758

Merged
merged 5 commits into from
Mar 11, 2022
Merged

[Docs] Add tutorial of dataset #758

merged 5 commits into from
Mar 11, 2022

Conversation

Yshuo-Li
Copy link
Collaborator

No description provided.

@wangruohui
Copy link
Member

  1. An item on index.rst is required to show it on the index page.
  2. We need to describe, when inheriting from base dataset, which method need to be overwritten ( load annotaion here) and what result is desired to be returned.

@wangruohui
Copy link
Member

Another suggestion:
As several existing dataset classes are referenced, we can try cross reference functionality.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#role-py-class

@wangruohui wangruohui merged commit 9afbf64 into open-mmlab:master Mar 11, 2022
@Yshuo-Li Yshuo-Li deleted the t_dataset branch April 7, 2022 07:41
Yshuo-Li added a commit to Yshuo-Li/mmediting that referenced this pull request Jul 15, 2022
@Yshuo-Li
[Docs] Add tutorial of dataset (open-mmlab#758)
577ff55 
* [Docs] Add tutorial of dataset

* Update index.rst

* Add example of new base dataset
Yshuo-Li added a commit to Yshuo-Li/mmediting that referenced this pull request Jul 15, 2022
@Yshuo-Li
[Docs] Add tutorial of dataset (open-mmlab#758)
ea563e1 
* [Docs] Add tutorial of dataset

* Update index.rst

* Add example of new base dataset
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wangruohui wangruohui wangruohui approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Yshuo-Li @wangruohui