-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
556f618
commit 86341cb
Showing
2 changed files
with
40 additions
and
30 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
# Contributions | ||
|
||
Contributions are welcome, encouraged, and appreciated! | ||
|
||
If you encounter any bugs while using `quantile-forest`, or believe there's a feature that would prove useful, feel free to [submit a new issue](https://github.com/zillow/quantile-forest/issues/new/choose). | ||
|
||
All contributions, suggestions, and feedback you submitted are accepted under the [project's license](https://github.com/zillow/quantile-forest/blob/main/LICENSE). | ||
|
||
## Setting Up Your Environment | ||
|
||
To contribute to the `quantile-forest` source code, start by forking and then cloning the repository (i.e. `git clone [email protected]:YourUsername/quantile-forest.git`) | ||
|
||
Once inside the repository, to build and install the package, run: | ||
|
||
```cmd | ||
python setup.py build_ext --inplace | ||
python setup.py install | ||
``` | ||
|
||
## Testing Your Changes | ||
|
||
To execute unit tests from the `quantile-forest` repository, run: | ||
|
||
```cmd | ||
pytest quantile_forest -v | ||
``` | ||
|
||
## Troubleshooting | ||
|
||
If the build fails because SciPy is not installed, ensure OpenBLAS and LAPACK are available and accessible. | ||
|
||
On macOS, run: | ||
|
||
```cmd | ||
brew install openblas | ||
brew install lapack | ||
export SYSTEM_VERSION_COMPAT=1 | ||
``` | ||
|
||
Then try rebuilding. |