Update macOS instructions in Numo docs #199
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
In jekyll#198, I added support for using [Numo::Linalg](https://github.com/ruby-numo/numo-linalg) as the linear algebra backend for classifier-reborn. At that time, I updated the docs with instructions for installing Numo, but the macOS docs were a little vague because I hadn't tested them myself. Since then, I've been able to verify the instructions on macOS and clarify a few steps. So this commit updates the docs for installing Numo on macOS. The gem installation arguments I'm using come from the [Numo docs](https://github.com/ruby-numo/numo-linalg/blob/master/doc/select-backend.md).
mattr-
reviewed
Aug 7, 2022
docs/index.md
Outdated
| * Install the [Numo::NArray](https://ruby-numo.github.io/narray/) and [Numo::Linalg](https://ruby-numo.github.io/linalg/) gems | ||
| * `gem install numo-narray numo-linalg` | ||
| * macOS: `brew install openblas` | ||
| * Install the [Numo::NArray](https://ruby-numo.github.io/narray/) and [Numo::Linalg](https://ruby-numo.github.io/linalg/) gems. If you're using Bundler, add `numo-narray` and `numo-linalg` to your Gemfile. |
There was a problem hiding this comment.
does the numo-linalg gem pick up the homebrew paths when built from bundler?
There was a problem hiding this comment.
No, it doesn't. If the gem is already installed correctly (using the notes below), simply adding these to the Gemfile will be fine because Bundler will use the installed Gem. But if installing for the first time, Bundler will need the build args. (As documented here in Bundler.)
If using Bundler, something like the following might be best:
bundle config set --global build.numo-linalg --with-openblas-dir=$(brew --prefix openblas) --with-lapack-lib="$(brew --prefix lapack)/lib"
I'll add a note about this.
Co-authored-by: Matt Rogers <[email protected]>
|
@mattr- Would you mind taking another look at my updates above when you have a chance? |
mattr-
approved these changes
Aug 30, 2022
|
Thank you for the ping and sorry for the delay in reviewing! @jekyllbot: merge +docs |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In #198, I added support for using
Numo::Linalg as the linear
algebra backend for classifier-reborn. At that time, I updated the docs
with instructions for installing Numo, but the macOS docs were a little
vague because I hadn't tested them myself. Since then, I've been able to
verify the instructions on macOS and clarify a few steps. So this commit
updates the docs for installing Numo on macOS. The gem installation
arguments I'm using come from the Numo
docs.