mila-iqia / fuel

A data pipeline framework for machine learning
MIT License
868 stars 268 forks source link

The docs for some classes are not generated automatically #374

Open icsong opened 8 years ago

icsong commented 8 years ago

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.