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

Refactor for public release #11

Merged
merged 27 commits into from
Dec 9, 2024
Merged

Refactor for public release #11

merged 27 commits into from
Dec 9, 2024

Conversation

se-jaeger
Copy link
Member

@se-jaeger se-jaeger commented Nov 27, 2024

This refactors (more than I have planned) some parts for more consistency within the code base and other ML packages.
It also adds some descriptions and examples to get users started.

@se-jaeger se-jaeger removed the WIP Wor in progress label Dec 6, 2024
@se-jaeger
Copy link
Member Author

So this are my suggestions, @philipp-jung. Please change what does not make sense and/or add what you are missing.

Copy link
Collaborator

@philipp-jung philipp-jung left a comment

Choose a reason for hiding this comment

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

Great overall improvement and a no-brainer to merge this asap.

Some notes:

  • We need some way of keeping track of todos. A great place would be a kanban board in bht-cloud. Github issues are public and often annoying to work with.
  • Documentation via the notebooks is fantastic imo. The next step would be to generate documentation from docstrings.
  • In terms of next steps of quality of the repo, my list of priorities would be (1) documentation, (2) automated tests, (3) working through other todos in the code.

examples/1-Getting-Started.ipynb Outdated Show resolved Hide resolved
examples/Error_Types.ipynb Outdated Show resolved Hide resolved
tab_err/error_mechanism/_error_mechanism.py Outdated Show resolved Hide resolved
tab_err/error_type/_category_swap.py Outdated Show resolved Hide resolved
tab_err/error_type/_error_type.py Show resolved Hide resolved
tab_err/error_type/_error_type.py Show resolved Hide resolved
tab_err/error_type/_permutate.py Show resolved Hide resolved
se-jaeger and others added 2 commits December 9, 2024 08:10
Co-authored-by: Philipp Jung <philippjung@posteo.de>
Co-authored-by: Philipp Jung <philippjung@posteo.de>
@se-jaeger se-jaeger merged commit 6078d83 into main Dec 9, 2024
24 checks passed
@se-jaeger se-jaeger deleted the refactor-for-public-release branch December 9, 2024 08:17
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.

2 participants