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

Add links to reqs and project plan #9

Closed
f-aguzzi opened this issue May 9, 2024 · 1 comment
Closed

Add links to reqs and project plan #9

f-aguzzi opened this issue May 9, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation released on @stable
Milestone

Comments

@f-aguzzi
Copy link
Owner

f-aguzzi commented May 9, 2024

No description provided.

@f-aguzzi f-aguzzi added the documentation Improvements or additions to documentation label May 9, 2024
@f-aguzzi f-aguzzi added this to the Overhaul milestone May 9, 2024
github-actions bot pushed a commit that referenced this issue May 17, 2024
## 1.0.0 (2024-05-17)

### ⚠ BREAKING CHANGES

* change package name
* **docs:** moved the `Docusaurus` folder up one level, removed all other documentation (now all inside of Docusaurus subpages)

### Features

* **CI:** automated pylint tests on push ([c794037](c794037))
* completed use case diagram ([63ce9e4](63ce9e4))
* **readme:** created readme with badges ([6691d18](6691d18)), closes [#5](#5)
* first draft of project plan ([8adb87d](8adb87d))
* implemented k-nearest neighbors ([63228a2](63228a2)), closes [#12](#12)
* **tests:** implemented lldf module unit tests ([9311da4](9311da4))
* implemented LR class ([ec3582c](ec3582c)), closes [#2](#2)
* implemented pca and lda ([c59147f](c59147f))
* implemented PLSDA ([af35254](af35254)), closes [#10](#10)
* implemented SVM ([a3e95bc](a3e95bc))
* **docs:** move all documentation into docusaurus ([e1f2e7d](e1f2e7d))
* **docs:** sequence and process UML diagrams ([bec766f](bec766f))
* **Colab:** set up notebook for Colab demo ([638a67f](638a67f)), closes [#4](#4)

### Bug Fixes

* **CI/CD:** add missing configuration files ([ebe28d5](ebe28d5))
* **CI:** added conditional activation of workflows ([aa4e916](aa4e916)), closes [#6](#6)
* **pylint:** added requirements, increased scores ([bef1cdf](bef1cdf))
* added test cases for LLDF, PCA, LDA, SVM ([0ba2f26](0ba2f26)), closes [#3](#3)
* **CI:** broken rye sync in workflows ([3c8482b](3c8482b))
* **LLDF:** datasheet export now works properly ([131d3db](131d3db))
* **CI:** fixed workflow triggers ([6069c89](6069c89))
* gh_pages workflow ([0a6fc43](0a6fc43))
* **notes:** merged obsidian duplicate folders ([234b200](234b200))
* removed pycache, changed favicon ([a6407f6](a6407f6))
* **CI/CD:** set GitGub token ([05a4440](05a4440)), closes [#15](#15)
* **docs:** spelling mistakes ([a10d512](a10d512))
* **notebook:** update broken links, remove checkpoints ([d8723a1](d8723a1)), closes [#14](#14) [#13](#13)
* **tests:** various mistakes in workflow script ([3d63d37](3d63d37))

### chore

* change package name ([bd5006d](bd5006d))
* **rye:** readapt project structure to rye ([38c66e6](38c66e6))
* **testing:** set up automated unit tests ([73b399e](73b399e))
* **CI/CD:** set up automatic releases ([8536dc2](8536dc2))
* **obsidian:** set up devlogs, kanban and uml ([f8ec9af](f8ec9af))
* **docs:** set up docusaurus and gh-pages ([3c957e8](3c957e8))
* set up project structure ([040fcfa](040fcfa))
* set up rye package manager ([f0eefd7](f0eefd7)), closes [#11](#11)

### Docs

* add links to project section pages ([9af2786](9af2786)), closes [#9](#9)
* first draft of requirements specification ([5d1b8c3](5d1b8c3))
* updated package name in examples ([33f051f](33f051f))

### Refactor

* **svm:** added proper kernel validation ([414cda8](414cda8)), closes [#8](#8)
* made project structure PEP-compliant ([b81e925](b81e925))
* upgrade pylint score ([d80e630](d80e630))
Copy link

🎉 This issue has been resolved in version 1.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation released on @stable
Projects
None yet
Development

No branches or pull requests

1 participant