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

Regenerate class diagrams #519

Merged
merged 8 commits into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,9 @@ During the development cycle, three main supporting branches are used:
3. Verify that the information in `CITATION.cff` is correct, and that `.zenodo.json` contains equivalent data.
4. Merge the release branch into `main` (and `dev`), and [run the tests](https://github.com/DeepRank/deeprank2/blob/dev/README.dev.md#running-the-tests).
5. Go to https://github.com/DeepRank/deeprank2/releases and draft a new release; create a new tag for the release, generate release notes automatically and adjust them, and finally publish the release as latest. This will trigger [a GitHub action](https://github.com/DeepRank/deeprank2/actions/workflows/release.yml) that will take care of publishing the package on PyPi.

## UML

Code-base class diagrams updated on 02/11/2023, generated with https://www.gituml.com (save the images and open them in the browser for zooming).
- Data processing classes and functions: <img src="./tests/utils/uml_data_processing.svg" width="50">
- ML pipeline classes and functions: <img src="./tests/utils/uml_training.svg" width="50">
53 changes: 0 additions & 53 deletions deeprank2/tools/classdiagrams.sh

This file was deleted.

Loading