Skip to content

Update stale docstrings, docs and tutorial outputs (#77) - #83

Merged
upadhyan merged 2 commits into
mainfrom
docs/77-update-stale-docs-tutorials
Oct 3, 2026
Merged

upadhyan merged 2 commits into
mainfrom
docs/77-update-stale-docs-tutorials

Conversation

@upadhyan

@upadhyan upadhyan commented Oct 3, 2026

Copy link
Copy Markdown
Collaborator

Closes #77.

Summary

  • Docstrings (sgtlearn/)
    • Documents tao_n_runs and tao_lambda on all four estimators.
    • States that feature importances raise after the default TAO fit.
    • Describes num_partitions as a maximum.
    • Notes that criterion also grows the inner trees and accepts "log_loss", and that max_features samples logical features.
    • Describes current regression seeding and MAE coordinate-descent gating.
    • Corrects pair-node NaN routing.
    • Adds full TAO_refine Parameters/Returns/Raises, noting that the cost is lambda_ * n_node with early stopping.
    • Adds plot_tree parameter semantics, feature_names_in_, the tree_export keys, and the missing predict/predict_proba docstrings.
    • Removes references to things that don't exist (fit(column_names=...), the private _export.plot_tree path).
  • Read the Docs pages
    • tao.rst: n_node cost, tao_pair_scale in the knob lists, candidate scope, early stopping.
    • estimators.rst / ensemble.rst: pairwise_penalty as the γ growth cost, λ disambiguated from tao_lambda, predict shapes.
    • Quickstart and installation (scikit-build-core, best-effort stubs).
    • Roadmap: v0.3.1 and Unreleased (export_text) sections.
    • Fixed about 20 broken cross-references.
    • conf.py: dropped the global inherited-members: False, which overrode :inherited-members: and hid fit/predict on the forest pages. Inherited sklearn methods now render too.
  • READMEs, examples, C++ docs
    • Build and layout sections corrected.
    • Binding docstrings and the regression header comment now match the code (comments only, no logic changes).
  • Notebooks
    • All 10 re-executed. Outputs are identical to v0.3.1; only the execution metadata changed, and split stdout blocks were merged.

Notes

Test plan

  • sphinx-build -W --keep-going -b html docs passes. With -n, no attr/meth/obj/func/mod reference warnings remain.
  • pytest tests: 1241 passed, 2 skipped.
  • ruff check sgtlearn is clean.
  • Extension rebuilt with the edited binding docstrings; re-executed notebooks give identical outputs.

🤖 Generated with Claude Code

upadhyan and others added 2 commits October 2, 2026 21:56
Outputs are numerically identical to v0.3.1; only execution metadata
and stream chunking changed (split stdout blocks merged).

Refs #77

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Bring docstrings, API pages, guides, roadmap, READMEs and C++ binding
docs in line with the current code: document tao_n_runs/tao_lambda and
the default-TAO feature-importance restriction, num_partitions as a
maximum, current regression seeding and MAE coordinate-descent gating,
TAO's n_node cost and early stopping, pair-node missing routing,
pairwise_penalty as a growth-score cost, v0.3.1/export_text roadmap
entries, and fix broken cross-references. Render inherited forest
methods by dropping the conf.py inherited-members override.

Closes #77

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@upadhyan upadhyan linked an issue Oct 3, 2026 that may be closed by this pull request
@upadhyan
upadhyan merged commit 28b5f1d into main Oct 3, 2026
24 checks passed
@upadhyan
upadhyan deleted the docs/77-update-stale-docs-tutorials branch October 3, 2026 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Stale Docs and Tutorials

1 participant