Skip to content

doc: local trees parameter documentation #2636

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

Open
ethanglaser wants to merge 5 commits into
base: main
Choose a base branch
from
Open

doc: local trees parameter documentation #2636

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
19051b9
doc: local trees parameter documentation
ethanglaser Jul 30, 2025
1242c79
Update doc/sources/algorithms.rst
ethanglaser Jul 30, 2025
f279089
Update doc/sources/algorithms.rst
ethanglaser Jul 30, 2025
6f0363a
Merge branch 'main' into dev/eglaser-local-trees-doc
ethanglaser Sep 26, 2025
1d075e5
add local_trees_mode details to tuning guide
ethanglaser Sep 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions doc/sources/algorithms.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,10 @@ Classification
- ``criterion`` != `'gini'`
- ``oob_score`` = `True`
- ``sample_weight`` != `None`

**Additional parameters:**

- ``local_trees_mode`` (bool, default=False): Enables local trees mode for distributed training. ``n_estimators`` is per rank, with isolated learning occurring on each processor before merging into a single model. This mode is experimental but scales better than default. This parameter is specific to the SPMD implementation and is not present in the standard scikit-learn API.
Copy link
Contributor

@david-cortes-intel david-cortes-intel Sep 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say this is not very descriptive.

  • Does it mean that the result has n_estimators*n_ranks trees?
  • Does the data get moved across ranks, or does each rank use the data that it owns?
  • Maybe could also refer to them as 'rank/nodes' as otherwise it might not be immediately clear what a 'rank' here refers to.

Copy link
Contributor Author

@ethanglaser ethanglaser Sep 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally we could point to oneDAL docs, where this functionality was implemented. @Alexandr-Solovev can we get this documented in oneDAL?

Copy link
Contributor

@Alexandr-Solovev Alexandr-Solovev Feb 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will create a JIRA task for update the docs, because for now we mention this parameter in onedal only in one place here:
https://github.com/uxlfoundation/oneDAL/blob/151df1d4b1e9c41b51997bc20a0544ada2bd51ec/cpp/oneapi/dal/algo/decision_forest/common.hpp#L519
But if it helps, I also can clarify David's questions:
Does it mean that the result has n_estimators*n_ranks trees? - No, oneDAL will split the n_trees across the ranks internally.
Does the data get moved across ranks, or does each rank use the data that it owns? - Each rank uses just local data(data that it owns).

- Multi-output and sparse data are not supported
* - :obj:`sklearn.ensemble.ExtraTreesClassifier`
- All parameters are supported except:
Expand Down Expand Up @@ -525,6 +529,10 @@ Regression
- ``criterion`` != `'mse'`
- ``oob_score`` = `True`
- ``sample_weight`` != `None`

**Additional parameters:**

- ``local_trees_mode`` (bool, default=False): Enables local trees mode for distributed training. `n_estimators` is per rank, with isolated learning occurring on each processor before merging into a single model. This mode is experimental but scales better than default. This parameter is specific to the SPMD implementation and is not present in the standard scikit-learn API.
- Multi-output and sparse data are not supported
* - :obj:`sklearn.ensemble.ExtraTreesRegressor`
- All parameters are supported except:
Expand Down
Loading