Skip to content
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.

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

docs: glossary for important terms #292

Merged
merged 13 commits into from
Jun 23, 2023

Conversation

patrikguempel
Copy link
Contributor

Closes #188.

Summary of Changes

Configured Snippets extension in mkdocs.yml
Created includes/glossary.md
Filled Glossary with various terms

guempelp0 and others added 2 commits April 25, 2023 14:33
@patrikguempel patrikguempel requested review from a team and lars-reimann as code owners May 5, 2023 20:42
@patrikguempel patrikguempel linked an issue May 5, 2023 that may be closed by this pull request
@lars-reimann
Copy link
Member

lars-reimann commented May 5, 2023

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ MARKDOWN markdown-link-check 1 0 0.36s
✅ REPOSITORY git_diff yes no 0.05s

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 May 5, 2023

Codecov Report

Merging #292 (2104101) into main (ccd1c25) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #292   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           47        47           
  Lines         2355      2355           
=========================================
  Hits          2355      2355           

@lars-reimann
Copy link
Member

lars-reimann commented May 5, 2023

Looks great! Some other ideas:

  • Metric
  • Underfitting
  • Overfitting
  • Classification
  • Regularization
  • Linear Regression
  • Feature
  • Target
  • Sample
  • Training set
  • Validation set
  • Test set
  • True positive
  • True negative
  • False positive
  • False negative
  • Confusion matrix

mkdocs.yml Outdated Show resolved Hide resolved
@lars-reimann lars-reimann marked this pull request as draft May 6, 2023 08:40
includes/glossary.md Outdated Show resolved Hide resolved
includes/glossary.md Outdated Show resolved Hide resolved
includes/glossary.md Outdated Show resolved Hide resolved
@patrikguempel patrikguempel marked this pull request as ready for review May 9, 2023 15:43
Copy link
Member

@lars-reimann lars-reimann left a comment

Choose a reason for hiding this comment

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

Looks great and it's a very nice starting point for future additions. I'd like some more cross-references in the documentation (see comments), then this can be merged.

docs/glossary.md Show resolved Hide resolved
docs/glossary.md Show resolved Hide resolved
@lars-reimann lars-reimann merged commit 2979f24 into main Jun 23, 2023
@lars-reimann lars-reimann deleted the 188-glossary-for-important-terms-in-safe-ds branch June 23, 2023 15:27
@lars-reimann
Copy link
Member

🎉 This PR is included in version 0.14.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@lars-reimann lars-reimann added the released Included in a release label Jun 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Included in a release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Glossary for important terms in Safe-DS
2 participants