The Wayback Machine - https://web.archive.org/web/20200928082746/https://github.com/BindsNET/bindsnet/issues/312
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

Reorganize Examples #312

Open
dee0512 opened this issue Sep 18, 2019 · 13 comments
Open

Reorganize Examples #312

dee0512 opened this issue Sep 18, 2019 · 13 comments

Comments

@dee0512
Copy link
Collaborator

@dee0512 dee0512 commented Sep 18, 2019

Examples to be removed:

  • space_invaders/et_space_invaders.py
  • space_invaders/minimal_space_invaders.py
  • space_invaders/random_baseline.py
  • asteroids/random_network_baseline.py
  • datasets/davis.py
  • datasets/spoken_mnist.py
  • mnist/batch_conv_mnist.py
  • mnist/minimal_mnist.py
  • mnist/minimal_resevoir.py
  • mnist/minimal_supervised_mnist.py
  • cifar10/*
  • notebooks/LIFNodes\ vs.\ CurrentLIFNodes.ipynb

Examples to be added:

  • breakout/random_baseline.py
  • breakout/random_network_baseline.py

Examples to be moved:

  • datasets/conv.py -> tensorboard/tensorboard.py
  • benchmark -> separate repo
@dee0512
Copy link
Collaborator Author

@dee0512 dee0512 commented Sep 18, 2019

@djsaunde can we move notebooks to bindsnet examples? We are planning to keep only examples that are required to help you understand Bindsnet. This would also reduce our workload when updating BindsNET.

@djsaunde
Copy link
Collaborator

@djsaunde djsaunde commented Sep 18, 2019

Yes, I think that's for the best. We've been talking for a while about removing a bunch of examples, since they're out of date / not super informative.

@sharath
Copy link
Contributor

@sharath sharath commented Sep 18, 2019

I think we should move BindsNET to an organization repo and move the benchmark stuff to a separate repo under this organization.

@sharath sharath added the enhancement label Sep 18, 2019
@djsaunde
Copy link
Collaborator

@djsaunde djsaunde commented Sep 18, 2019

Yup, I'm in the process of convincing Robert to let us move BindsNET to a BINDS GitHub organization

@Hananel-Hazan
Copy link
Collaborator

@Hananel-Hazan Hananel-Hazan commented Sep 18, 2019

This is not relevant to this thread nor to public forum.
There is a plan to move to an organization, that plan involve lots of moving parts. Currently, BindsNET is in the right place to take advantage of that plan.

@sharath sharath changed the title Update examples Reorganize Examples Sep 18, 2019
@dee0512
Copy link
Collaborator Author

@dee0512 dee0512 commented Sep 18, 2019

So what do we do with the benchmarking examples? They require brian, ANNarchy, etc. which are not part of Bindsnet and are not relevant to normal users.

@dee0512
Copy link
Collaborator Author

@dee0512 dee0512 commented Sep 18, 2019

Also, can everyone react to this comment to confirm all the examples to be removed? We tried to remove redundant and non-useful examples. Objections are welcome.

@Hananel-Hazan
@djsaunde
@sharath
@coopersigrist

@Hananel-Hazan
Copy link
Collaborator

@Hananel-Hazan Hananel-Hazan commented Sep 18, 2019

The ideal situation is that on every big feature that we have, there is example that show how it works. But we cannot maintain so many examples.
So, I think:

  1. benchmark can be in docs and not in examples. This script is needed to reproduce the figure in the BindsNET paper
  2. All the examples in the BindsNET paper need to stay.
  3. Minimal and not minimal need to be combine to one example (if any)
  4. Unless it necessary, one example from the ATARI can explain how to use the framework to all other ATARI game. No need for multiple ATARI examples.

I also think that there is need to show some aspects of BindsNET.

  1. Core examples for BindsNET - different architecture, different neurons, maybe different learning rules
  2. Data-set examples - show how to connect and fetch data
  3. RL examples - how to work with feedback

Open to suggestions

@dee0512
Copy link
Collaborator Author

@dee0512 dee0512 commented Sep 19, 2019

I agree with Hananel on most of the points. But:

The examples in the Bindsnet paper might not be relevant anymore. For eg. Pipeline.

People can learn how to use datasets from the Docs. Same goes for neurons, architectures and learning rules. One Atari example should be enough to show how to work with rewards in RL.
So, I would suggest that instead of writing and maintaining an example for every major update, we update the documentation.

@Hananel-Hazan
Copy link
Collaborator

@Hananel-Hazan Hananel-Hazan commented Sep 19, 2019

Yes, you right, pipeline and datasets can be in the documents. But, although the examples from the paper are less relevant today, they are the first that going to be use by people that been introduce to the framework by reading the paper (quite a lots of people if you look on frontier page counter).

Still some example need to be maintain, not all people read the doc first, some clone and run the examples first before diving to the documents to see what else the framework can do.
Therefore we need to choose top highly relevant examples for the novel user.

What would be the relevant examples?
RL, RNN (reservoir), CNN, SOM, batch learning?
Anything else, anything less?

@Hananel-Hazan
Copy link
Collaborator

@Hananel-Hazan Hananel-Hazan commented Sep 24, 2019

mnist/reservoir is functional (I update @sharath project)
cifar10/cifar10_reservoir.py is next

@dee0512
Copy link
Collaborator Author

@dee0512 dee0512 commented Sep 25, 2019

We planned on removing cifar10 examples.

@Ondrysak
Copy link

@Ondrysak Ondrysak commented Feb 3, 2020

maybe a related issue #350 ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.