Improved manual - Githubissues

AlexMili / torch-dataframe

Utility class to manipulate dataset from CSV file

MIT License

67 stars 8 forks source link

Improved manual #15

Open gforge opened 8 years ago

gforge commented 8 years ago

The README is currently lagging. We need to cover:

batch functionality
exemplify how to set up a network using the dataframe
the basic statistics available

... and more. I'm not sure if it's best to build a larger README or if we should start a doc-folder. Anyway the README requires a TOC to start with.

AlexMili commented 8 years ago

You're right, we can't let the README get bigger and bigger. I think we should keep the "doc" term (and directory) for the API documentation and use the WIKI for tutorials, examples, etc.

gforge commented 8 years ago

Sounds good. Do we have the WIKI outside the project or is the WIKI handled using regular PRs?

AlexMili commented 8 years ago

For now the regular Github WIKI will be fine.