[Tracking Issue] Add document strings to public methods

Open
#215 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
julia

Research direction

Use issue #214 as the format reference, then review the unchecked public methods listed here, including build_tree, print_tree, apply_tree, the AdaBoost helpers, cross-validation methods, and importance utilities. Add document strings for the selected public methods and mark the corresponding checklist items complete.

Written by the indexing model from the issue text.

Description

documentation

Here's what I think are intended to be public, ranked in rough order of priority:

  • build_forest #214 @ablaom
  • apply_forest
  • apply_forest_proba
  • build_tree (keep #224 in mind)
  • print_tree
  • apply_tree
  • apply_tree_proba
  • build_adaboost_stumps
  • apply_adaboost_stumps
  • apply_adaboost_stumps_proba
  • prune_tree
  • nfoldCV_forest
  • nfoldCV_tree
  • nfoldCV_stumps
  • load_data
  • DecisionTree.confusion_matrix
  • DecisionTree.util.gini
  • DecisionTree.util.entropy
  • DecisionTree.util.zero_one
  • impurity_importance
  • split_importance
  • permutation_importance

Any help here appreciated. Take a look at #214 to get an idea of existing format.

Dominant language
Julia
Stars
365
Forks
100
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from JuliaAI/DecisionTree.jl

All issues in JuliaAI/DecisionTree.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.