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

JOSS documentation fixes #1421

Merged
merged 9 commits into from Jun 8, 2018

Conversation

Projects
None yet
3 participants
@rcurtin
Member

rcurtin commented Jun 4, 2018

This is a collection of fixes for the issues brought up by @rasbt:

  • Clarify how to use the Python bindings without installation and mention when LD_LIBRARY_PATH might be needed. (#1416)
  • Print output = before automatically-generated calls to Python bindings in documentation. (#1418)
  • Change name of perceptron variable in the perceptron code documentation. (#1419)
  • Rewrite the kRANN documentation since it was written specifically for command-line bindings and never updated.
  • Write the random forest documentation since it seems it never actually got written.

Since these fix some fairly important documentation issues from the Python angle, I would have no problem doing a release after this merge as mlpack 3.0.2.

@zoq

zoq approved these changes Jun 5, 2018

Looks good to me, no comments from my side.

@rcurtin

This comment has been minimized.

Member

rcurtin commented Jun 5, 2018

Ok, I will go ahead and merge this in three days.

@rcurtin rcurtin merged commit 4c008c4 into mlpack:master Jun 8, 2018

4 of 5 checks passed

Static Code Analysis Checks Build finished.
Details
Memory Checks
Details
Style Checks Build finished.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@rasbt

This comment has been minimized.

rasbt commented Jun 8, 2018

That's great, as far as I can tell from the changelog, it addresses all the issues that came up during the JOSS review :).

Maybe I am too early, but in case this is not a temporary thing, the links (e.g., under Python Bindings) don't work, yet:

Not Found

The requested URL /docs/mlpack-3.0.2/python/perceptron.html was not found on this server.

@rcurtin rcurtin deleted the rcurtin:joss-doc-fixes branch Jun 9, 2018

@rcurtin

This comment has been minimized.

Member

rcurtin commented Jun 9, 2018

Yep, sorry about that---I was in the process of doing the release and accidentally changed the links on the homepage before the documentation was built, and then was interrupted by dinner and a movie. :)

The documentation works now, and addresses the various issues that you pointed out. Thank you again!

@rasbt

This comment has been minimized.

rasbt commented Jun 9, 2018

No worries, and it works fine now!

@rasbt rasbt referenced this pull request Jun 9, 2018

Closed

[REVIEW]: mlpack 3: a fast, flexible machine learning library #726

53 of 54 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment