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

Add View tutorial #493

Merged
merged 5 commits into from
Nov 14, 2024
Merged

Add View tutorial #493

merged 5 commits into from
Nov 14, 2024

Conversation

jnsbck
Copy link
Contributor

@jnsbck jnsbck commented Nov 8, 2024

I added a tutorial to introduce the concepts behind Views and Modules, since I think understanding the basics is really helpful to work with Jaxley effectively and at the moment you'd have to figure it out yourself from the API docs.

This is a first draft. Your feedback would be much appreciated.

@kyralianaka @michaeldeistler.

@michaeldeistler
Copy link
Contributor

I will have a look later. Is it ok if I just push to the branch?

@jnsbck
Copy link
Contributor Author

jnsbck commented Nov 13, 2024

Yes, fine with me.

@michaeldeistler
Copy link
Contributor

michaeldeistler commented Nov 13, 2024

Awesome!

I think it's great to have a central place where all of these concepts are explained, and I think that users will find this very useful.

However, I would not suggest to make it the first tutorial---it is quite detailed and it is not very satisfying to end the first tutorial with "hey here is your network, but you cannot do anything with it yet".

So, I suggest the following (which I will push in a second, but we can ofc revert if you disagree):

  • I copied some parts of your tutorial to 01_morph_neurons.ipynb, in particular using cell.nodes and cell.branch(0).nodes to inspect the module.
  • I added links to your new tutorial in the 01_ tutorial and once in the 03_ tutorial
  • I added your new tutorial as the first tutorial of the Advanced tutorials section (I created this new section in New tutorials on indexing and parameter sharing #464)

Let me know what you think!

@michaeldeistler
Copy link
Contributor

On a side-note, I just realized that all our links in tutorials are still going to the old website...I changed this now.

@jnsbck
Copy link
Contributor Author

jnsbck commented Nov 14, 2024

Awesome!

I think it's great to have a central place where all of these concepts are explained, and I think that users will find this very useful.

However, I would not suggest to make it the first tutorial---it is quite detailed and it is not very satisfying to end the first tutorial with "hey here is your network, but you cannot do anything with it yet".

So, I suggest the following (which I will push in a second, but we can ofc revert if you disagree):

* I copied some parts of your tutorial to `01_morph_neurons.ipynb`, in particular using `cell.nodes` and `cell.branch(0).nodes` to inspect the module.

* I added links to your new tutorial in the `01_` tutorial and once in the `03_` tutorial

* I added your new tutorial as the first tutorial of the `Advanced tutorials` section (I created this new section in [New tutorials on indexing and parameter sharing #464](https://github.com/jaxleyverse/jaxley/pull/464))

Let me know what you think!

Sounds great to me! I added it as 00_ mainly cos I was not sure where to put it. I also very much like having an "advanced" section.

Feel free to merge it.

@michaeldeistler michaeldeistler merged commit 15fce42 into main Nov 14, 2024
1 check passed
@michaeldeistler michaeldeistler deleted the add_view_tutorial branch November 14, 2024 11:27
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.

2 participants