Skip to content

Add tutorial notebooks covering installation to evaluation - #337

Closed
Sharkyii wants to merge 1 commit into
mllam:mainfrom
Sharkyii:tutorials
Closed

Add tutorial notebooks covering installation to evaluation#337
Sharkyii wants to merge 1 commit into
mllam:mainfrom
Sharkyii:tutorials

Conversation

@Sharkyii

@Sharkyii Sharkyii commented Mar 5, 2026

Copy link
Copy Markdown
Contributor

Describe your changes

Added 5 tutorial notebooks to help new users get started with Neural-LAM:

  1. Getting started guide - installation through first prediction
  2. Working with custom datasets
  3. Understanding and optimizing graph structures
  4. Advanced training techniques
  5. Evaluating and visualizing results(This is on the way 🚧)

Issue Link

For GSoC Project-2

Type of change

  • 🐛 Bug fix (non-breaking change that fixes an issue)
  • ✨ New feature (non-breaking change that adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation (Addition or improvements to documentation)

Checklist before requesting a review

  • My branch is up-to-date with the target branch - if not update your fork with the changes from the target branch (use pull with --rebase option if possible).
  • I have performed a self-review of my code
  • For any new/modified functions/classes I have added docstrings that clearly describe its purpose, expected inputs and returned values
  • I have placed in-line comments to clarify the intent of any hard-to-understand passages of my code
  • I have updated the README to cover introduced code changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have given the PR a name that clearly describes the change, written in imperative form (context).
  • I have requested a reviewer and an assignee (assignee is responsible for merging). This applies only if you have write access to the repo, otherwise feel free to tag a maintainer to add a reviewer and assignee.

Checklist for reviewers

Each PR comes with its own improvements and flaws. The reviewer should check the following:

  • the code is readable
  • the code is well tested
  • the code is documented (including return types and parameters)
  • the code is easy to maintain

Author checklist after completed review

  • I have added a line to the CHANGELOG describing this change, in a section
    reflecting type of change (add section where missing):
    • added: when you have added new functionality
    • changed: when default behaviour of the code has been changed
    • fixes: when your contribution fixes a bug
    • maintenance: when your contribution is relates to repo maintenance, e.g. CI/CD or documentation

Checklist for assignee

  • PR is up to date with the base branch
  • the tests pass
  • (if the PR is not just maintenance/bugfix) the PR is assigned to the next milestone. If it is not, propose it for a future milestone.
  • author has added an entry to the changelog (and designated the change as added, changed, fixed or maintenance)
  • Once the PR is ready to be merged, squash commits and merge the PR.

@Sharkyii Sharkyii changed the title Added tutorials Add tutorial notebooks covering installation to evaluation Mar 5, 2026
@sadamov

sadamov commented Mar 8, 2026

Copy link
Copy Markdown
Collaborator

@Sharkyii thanks a lot for these four notebooks. The getting_started one has a lof of overlap with #202. Would you mind implementing your ideas in that PR directly for the first notebook? Especially your visuaizations seem pretty nice!

Just wanted to mention this to prevent duplicate work.

@Sharkyii

Sharkyii commented Mar 9, 2026

Copy link
Copy Markdown
Contributor Author

@sadamov Sure, i am happy to do that.

@sadamov
sadamov self-requested a review March 12, 2026 19:40
@sadamov sadamov added the documentation Improvements or additions to documentation label Mar 12, 2026

@sadamov sadamov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'll mark this as a draft for now since it is rather related to a GSoC project proposal and not directly an issue here on GitHub. As mentioned before there is great work going on in #202 where we can continue the discussion.

@sadamov
sadamov marked this pull request as draft March 16, 2026 05:32
@Sharkyii Sharkyii closed this May 22, 2026
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants