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.

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

The docs for some classes are not generated automatically #374

Open
icsong opened this issue Nov 15, 2016 · 0 comments
Open

The docs for some classes are not generated automatically #374

icsong opened this issue Nov 15, 2016 · 0 comments

Comments

@icsong
Copy link

icsong commented Nov 15, 2016

I am trying to fit my data to Fuel and found some example code snippets on the Internet.
They were using classes such as Padding, Mapping, etc in fuel.transformers.
but I couldn't find the descriptions of those classes on the following web page:

http://fuel.readthedocs.io/en/latest/api/transformers.html

I looked into the source code of Fuel and found those classes and their documentations here:

https://github.com/mila-udem/fuel/blob/master/fuel/transformers/__init__.py

In fact, they were well documented!

I also do not find any documentation on the Web for classes such as PytablesDataset and H5PYDataset in the following file:

https://github.com/mila-udem/fuel/blob/master/fuel/datasets/hdf5.py

on http://fuel.readthedocs.io/en/latest/api/dataset.html.

It would be good to see the docs on the Web.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant