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

Upgrade tutorials for interactive parallel mode #1406

Merged
merged 77 commits into from
Mar 28, 2024
Merged

Conversation

ClaudiaComito
Copy link
Contributor

@ClaudiaComito ClaudiaComito commented Mar 21, 2024

Due Diligence

  • General:
  • Implementation:
    • unit tests: all split configurations tested
    • unit tests: multiple dtypes tested
    • documentation updated where needed

Description

This is an upgrade of our tutorials following the Heat tutorial at deRSE24.

There are two versions of the introduction, one for local usage (in tutorials/local), the other for the JSC clusters via jupyter-jsc, which was the original plan for the deRSE24 tutorial.

The other tutorials are the same, indeed tutorials/hpc contains symbolic links to the local tutorials.

While testing the local tutorials, I realized our conda build did not support osx-arm64 architecture. This has now been fixed on conda-forge (here and then here)

Issue/s resolved: #1252

Changes proposed:

  • introduce a tutorials directory with local and hpc jupyter notebooks
  • introduce tutorials for internal functions, matrix factorizations, data loading / preprocessing, and an interactive version of the clustering tutorial from ReadTheDocs
  • removed old tutorial and interactive scripts
  • updated links on README. Any other docs update will be within Unify documentation GitHub/ReadTheDocs #1242

Still todo:

Type of change

  • Documentation update

Memory requirements

NA

Performance

NA

Does this change modify the behaviour of other functions? If so, which?

no

@ClaudiaComito ClaudiaComito added PR talk documentation Anything related to documentation labels Mar 21, 2024
@ClaudiaComito ClaudiaComito added this to the 1.4.0 milestone Mar 21, 2024
JuanPedroGHM
JuanPedroGHM previously approved these changes Mar 25, 2024
Copy link
Collaborator

@mrfh92 mrfh92 left a comment

Choose a reason for hiding this comment

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

Looks very well :)
Thanks for all that work 👍

@ClaudiaComito ClaudiaComito merged commit 09a58fe into main Mar 28, 2024
52 checks passed
@mtar mtar deleted the docs/tutorials-hpc branch March 28, 2024 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Anything related to documentation PR talk
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Summarize Heat internal functions for new contributors
3 participants