Skip to content

Commit

Permalink
Update developer docs to ensure compatibility with latest scikit-lear…
Browse files Browse the repository at this point in the history
…n. (#319)

* updated developer documentation to install latest sklearn for compatability
  • Loading branch information
ryanhausen authored Sep 5, 2024
1 parent 244c706 commit bcf4b12
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
8 changes: 6 additions & 2 deletions DEVELOPING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ If you are developing locally, you will need the build dependencies to compile t

pip install -r build_requirements.txt

Additionally, you need to install the latest build of scikit-learn:

pip install --force -r build_sklearn_requirements.txt

Other requirements can be installed as such:

pip install .
Expand Down Expand Up @@ -132,7 +136,7 @@ You can also do the same thing using Meson/Ninja itself. Run the following to bu
export PYTHONPATH=${PWD}/build/lib/python<YOUR_PYTHON_VERSION>/site-packages

# to check installation, you need to be in a different directory
cd docs;
cd docs;
python -c "from treeple import tree"
python -c "import sklearn; print(sklearn.__version__);"

Expand Down Expand Up @@ -188,7 +192,7 @@ GH Actions will build wheels for each Python version and OS. Then the wheels nee
<https://github.com/neurodata/treeple/actions/workflows/build_wheels.yml> will have all the wheels for common OSes built for each Python version.

2. Upload wheels to test PyPi
This is to ensure that the wheels are built correctly and can be installed on a fresh environment. For more information, see <https://packaging.python.org/guides/using-testpypi/>. You will need to follow the instructions to create an account and get your API token for testpypi and pypi.
This is to ensure that the wheels are built correctly and can be installed on a fresh environment. For more information, see <https://packaging.python.org/guides/using-testpypi/>. You will need to follow the instructions to create an account and get your API token for testpypi and pypi.

```
twine upload dist/* --repository testpypi
Expand Down
3 changes: 3 additions & 0 deletions build_sklearn_requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
--pre
--extra-index https://pypi.anaconda.org/scientific-python-nightly-wheels/simple
scikit-learn

0 comments on commit bcf4b12

Please sign in to comment.