Expand docs to include cut and past examples for different Regressors

Open
#150 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

The issue names no files, tests, or documentation entry points; start by locating the existing regressor documentation and examples. Add copy-and-paste examples for the available regressors and explain when one model may be more appropriate than another, then verify the documentation builds and the examples are usable.

Written by the indexing model from the issue text.

Description

I think we could reduce learning curves by including some cut and past examples for the various regressors... it would also be good to include some discussion of when one Regressor model might be more appropriate than another.

Dominant language
Julia
Stars
86
Forks
16
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/MLJLinearModels.jl

All issues in JuliaAI/MLJLinearModels.jl

Similar issues

More Julia issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.