NeuroBench / neurobench

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

torch, torchaudio, and metavision_ml are mock imports due to docugen issues #123

Closed EssentiallyNoah closed 2 months ago

EssentiallyNoah commented 9 months ago

Can this be fixed? Does it have any impact on the documentation quality?

jasonlyik commented 4 months ago

Try making torch lightning mock import to fix documentation here: https://neurobench.readthedocs.io/en/latest/neurobench.datasets.html#wireless-sensor-data-mining

jasonlyik commented 4 months ago
image

@ben9809 After adding pytorch_lightning as mock import, the documentation looks like above. It is sparse, but probably better than the current docs which are bloated with lightning docs: https://neurobench.readthedocs.io/en/latest/neurobench.datasets.html#wireless-sensor-data-mining

What do you think about the dataset documentation?

ben9809 commented 4 months ago

@jasonlyik it looks way better. I could add more detailed documentation for the class WISDM and the two methods convert_to_tensor and create_directory

jasonlyik commented 4 months ago

Sounds good, please feel free to make the commits directly to the documentation branch