8000 Doc polish: "Data Loaders" --> "Datasets" · Issue #222 · asyml/texar-pytorch · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Doc polish: "Data Loaders" --> "Datasets" #222

New issue

Have a quest 8000 ion 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
Open
ZhitingHu opened this issue Oct 4, 2019 · 6 comments
Open

Doc polish: "Data Loaders" --> "Datasets" #222

ZhitingHu opened this issue Oct 4, 2019 · 6 comments
Assignees
@huzecong
Labels
enhancement New feature or request topic: docs Issue about docstrings and documentation

Comments

@ZhitingHu
Copy link
Member

The section is titled "Data Loaders" https://texar-pytorch.readthedocs.io/en/latest/code/data.html#data-loaders

Would "Datasets" be better? Or does "Data Loaders" fit the Pytorch convention better?

@huzecong @AvinashBukkittu
@AvinashBukkittu
Copy link
Collaborator

I personally like Datasets as section heading here. All the classes described under this are Datasets provided by texar. Our Data Iterators share similarities with Data Loaders of pytorch. Also, I see that we are missing the doc for SingleDatasetIterator. I don't know if this was intentional.

@ZhitingHu ZhitingHu added enhancement New feature or request topic: docs Issue about docstrings and documentation labels Oct 4, 2019
@ZhitingHu
Copy link
Member Author

The doc of Args is missing for Batch https://texar-pytorch.readthedocs.io/en/latest/code/data.html#texar.torch.data.Batch

@ZhitingHu
Copy link
Member Author

Thanks for the clarifation. Can these definitions be added to somewhere in the doc?

@ZhitingHu
Copy link
Member Author

We can probably have an "Overview" page for each set of modules, to give an overview and highlight key features. Like in TF: https://www.tensorflow.org/api_docs/python/tf/data

@huzecong
Copy link
Collaborator
huzecong commented Oct 4, 2019

Sure. I'll get on it.

@huzecong huzecong self-assigned this Oct 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@huzecong huzecong

Labels
enhancement New feature or request topic: docs Issue about docstrings and documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ZhitingHu @AvinashBukkittu @huzecong
0