Skip to content

Comments

feat: add suffixes to models to indicate their task#588

Merged
lars-reimann merged 4 commits intomainfrom
model-suffixes
Mar 30, 2024
Merged

feat: add suffixes to models to indicate their task#588
lars-reimann merged 4 commits intomainfrom
model-suffixes

Conversation

@lars-reimann
Copy link
Member

@lars-reimann lars-reimann commented Mar 30, 2024 •
edited
Loading

Summary of Changes

Add the suffix Classifier to all models for classification and Regressor to all models for regression. While being longer, this naming has many advantages:

  • Better readability: Several models have variants for classification and regressions. Previously, both had the same name, so to understand which one was used in the code, imports had to be checked.
  • Better auto-completion: Now users can simply write Classifier or Regressor to get a list of all suitable models.
  • Better understandability: Now it's obvious, that logistic regression is used for classification.

@lars-reimann lars-reimann requested a review from a team as a code owner March 30, 2024 15:58
@github-actions
Copy link
Contributor

github-actions bot commented Mar 30, 2024 •
edited
Loading

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdown-link-check 1 0 0.41s
✅ PYTHON black 38 0 0 1.38s
✅ PYTHON mypy 38 0 2.6s
✅ PYTHON ruff 38 0 0 0.17s
✅ REPOSITORY git_diff yes no 0.26s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by OX Security

@codecov
Copy link

codecov bot commented Mar 30, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ea176fc) to head (96f48f1).

Additional details and impacted files 
@@            Coverage Diff            @@
##              main      #588   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           53        53           
  Lines         3198      3198           
=========================================
  Hits          3198      3198

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lars-reimann lars-reimann merged commit d490dee into main Mar 30, 2024
@lars-reimann lars-reimann deleted the model-suffixes branch March 30, 2024 16:20
lars-reimann pushed a commit that referenced this pull request Apr 3, 2024
@semantic-release-bot
chore(release): 0.20.0 [skip ci]
98bccd0 
## [0.20.0](v0.19.0...v0.20.0) (2024-04-03)

### Features

* add deterministic hash methods to all types ([#573](#573)) ([f6a3ca7](f6a3ca7))
* add fnn functionality ([#529](#529)) ([ce53153](ce53153)), closes [#522](#522)
* add suffixes to models to indicate their task ([#588](#588)) ([d490dee](d490dee))
* added lag_plot ([#548](#548)) ([0fb38d2](0fb38d2)), closes [#519](#519)
* added normal plot for time series ([#550](#550)) ([dbdf11e](dbdf11e)), closes [#549](#549)
* when using from table to time series feature must be given ([#572](#572)) ([ca23f0f](ca23f0f)), closes [#571](#571)

### Bug Fixes

* incorrect type hint for `number_of_bins` parameter ([#567](#567)) ([b434e53](b434e53))
* mark various API elements as internal ([#587](#587)) ([ea176fc](ea176fc)), closes [#582](#582) [#585](#585)
@lars-reimann
Copy link
Member Author

lars-reimann commented Apr 3, 2024

🎉 This PR is included in version 0.20.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

released Included in a release

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@lars-reimann @megalinter-bot