NeuroBench / neurobench

Benchmark harness and baseline results for the NeuroBench algorithm track.
https://neurobench.readthedocs.io
Apache License 2.0
55 stars 12 forks source link

Updated tutorial #171

Closed V0XNIHILI closed 8 months ago

V0XNIHILI commented 9 months ago

SOLVED

@Maxtimer97 right now, the tutorial demonstrates how to download the dataset, but we can also just set the download is true flag when creating the MSWC class right?

image

V0XNIHILI commented 9 months ago

SOLVED

Also, some headings in the tutorial now end with ":" while others don't, I think we should pick one and use that one consistently:

image

V0XNIHILI commented 9 months ago

How does this work?

image

Is every batch guaranteed to only have samples from one class? If yes, I think this should be clarified because that is not an assumption users will make immediately I think.

V0XNIHILI commented 9 months ago

SOLVED with d76324b

BATCH_SIZE is defined here:

image

But only in a few data loaders and not in all + it's not clear why only in those.

V0XNIHILI commented 9 months ago

Not related to the tutorial, but why isn't query_classes part of query?

image

V0XNIHILI commented 9 months ago

Not clear why this is the case:

image

Maxtimer97 commented 9 months ago

@Maxtimer97 right now, the tutorial demonstrates how to download the dataset, but we can also just set the download is true flag when creating the MSWC class right?

image

I didn't see this download code before, I agree that it is nicer to use it. However when trying to run it, it didn't work for me. I rearranged it in this new commit which works for me: c89735670a9a1d6917ab61544208de4da43eb0ae This now requires the root to be just the data/ folder and adds the MSWC/ manually.

Can you check if this works for you/ if you see some mistakes I incerted?

V0XNIHILI commented 9 months ago

Works @Maxtimer97!

image
Maxtimer97 commented 9 months ago

Also, some headings in the tutorial now end with ":" while others don't, I think we should pick one and use that one consistently:

image

SOLVED: 4e692ed

Maxtimer97 commented 9 months ago

How does this work?

image

Is every batch guaranteed to only have samples from one class? If yes, I think this should be clarified because that is not an assumption users will make immediately I think.

I provided an extra explanation when loading the dataloader. Do you think it's clear now? It is in this commit: d26e297

image
Maxtimer97 commented 9 months ago

Not related to the tutorial, but why isn't query_classes part of query?

image

My point was that the list of all unique classes present in the dataset (query_classes) is not a usual argument to have in such an object so it is better to give it directly to users so they don't miss it (as it is quite useful in FSCIL). I would keep it like that if it's not a problem with you.

Maxtimer97 commented 9 months ago

Not clear why this is the case:

image

I added a bit more explanation in commit c3da584 The idea is just that we want to define the Benchmark object only once fixing the metrics of interest and then change the data to test on over successive sessions.

image
jasonlyik commented 8 months ago

@V0XNIHILI @Maxtimer97 The tutorial and cleaned up script look really great! Merging it all to prep for v1.0.