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

[MRG] Update documentation and add quick start guide #88

Merged
merged 32 commits into from
Jul 3, 2019
Merged

[MRG] Update documentation and add quick start guide #88

merged 32 commits into from
Jul 3, 2019

Conversation

rflamary
Copy link
Collaborator

@rflamary rflamary commented Jun 19, 2019 •
edited
Loading

This PR aim at updating the documentation of POT with the following items:

  • Add a quick starting guide that explain the overall architecture of POT and where to find the functions.
  • Add a small documentation for each submodules with reference papers
  • Add the new examples to the doc
  • Cleanup some doctrings errors in FGW functions
  • Make it clear fact that some modules are not imported by default (gpu , closes Cannot run gpu modules #85)
  • Better explain the fact that cython and numpy are necessary for installing (closes fail when using "pip install POT" #59)

The current build of the documentation for this PR is available here:
https://pot.readthedocs.io/en/doc_modules/

Note that this is still a work in progress.

@rflamary rflamary mentioned this pull request Jun 19, 2019
Merged
@rflamary rflamary changed the title [WIP] Update documentation of modules and add quick start guide [WIP] Update documentation and add quick start guide Jun 28, 2019
@rflamary rflamary changed the title [WIP] Update documentation and add quick start guide [MRG] Update documentation and add quick start guide Jul 3, 2019
@rflamary rflamary merged commit 952503e into master Jul 3, 2019
@rflamary rflamary deleted the doc_modules branch July 5, 2019 07:53
@rflamary rflamary restored the doc_modules branch July 5, 2019 07:55
@leotrs leotrs mentioned this pull request Jul 8, 2019
Closed
@rflamary rflamary deleted the doc_modules branch October 17, 2019 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Cannot run gpu modules fail when using "pip install POT"
1 participant
@rflamary