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

Added XOR-Regression tutorial. #227

Merged
merged 5 commits into from
Sep 9, 2023

Conversation

ahenkes1
Copy link
Contributor

@ahenkes1 ahenkes1 commented Aug 21, 2023

Objective of pull request:

I wrote a simple, minimalistic regression tutorial using the lava-dl framework. It consists of optional installation instructions for Google Colab, such that everybody can directly dive into it without problems! A simple XOR task is solved using a small CUBA network. Despite being a toy example, this tutorial can aid as a basis for LAVA-DL beginners interested in regression tasks. Important keywords are linked to further resources.

Pull request checklist

Your PR fulfills the following requirements:

  • Issue created that explains the change and why it's needed
  • Tests are part of the PR (for bug fixes / features)
  • Docs reviewed and added / updated if needed (for bug fixes / features)
  • [ x] PR conforms to Coding Conventions
  • [ x] PR applys BSD 3-clause or LGPL2.1+ Licenses to all code files
  • [x ] Lint (flakeheaven lint src/lava tests/) and (bandit -r src/lava/.) pass locally
  • [x ] Build tests (pytest) passes locally

Pull request type

  • Bugfix
  • Feature
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Documentation changes
  • [x ] Other (please describe): Tutorial

Does this introduce a breaking change?

  • Yes
  • [x ] No

Supplemental information

Copy link
Contributor

@bamsumit bamsumit left a comment

Choose a reason for hiding this comment

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

Thanks @ahenkes1 for the contribution. This looks good overall. I especially like the thorough description :). Here are few of my comments.

  1. Please get rid of this installation cell.
    image

  2. How about using a classifier instead of None. This is a classification problem. It would be good to see the accuracy.
    image

@timcheck
Copy link
Contributor

Thanks @ahenkes1, looks really nice. I agree with @bamsumit install instructions are already available https://github.com/lava-nc/lava-dl/#windowsmacoslinux, so should not be included in the tutorial itself.

You could also add your tutorial to the list of tutorials on https://github.com/lava-nc/lava-dl#getting-started.

@ahenkes1
Copy link
Contributor Author

@timcheck , @bamsumit everything should be fine now!

@ahenkes1
Copy link
Contributor Author

ahenkes1 commented Sep 5, 2023

Hello @timcheck , @bamsumit , @PhilippPlank , is there still something to do here?

Copy link
Contributor

@bamsumit bamsumit left a comment

Choose a reason for hiding this comment

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

Looks good @ahenkes1 . Thank you for your contribution.

@bamsumit bamsumit merged commit 3e9d3ee into lava-nc:main Sep 9, 2023
5 checks passed
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.

4 participants