sparse icon indicating copy to clipboard operation
sparse copied to clipboard

Adding notebooks to docs

Open prady0t opened this issue 5 months ago โ€ข 4 comments

What type of PR is this? (check all applicable)

  • [ ] ๐Ÿ’พ Refactor
  • [ ] ๐Ÿช„ Feature
  • [ ] ๐Ÿž Bug Fix
  • [ ] ๐Ÿ”ง Optimization
  • [x] ๐Ÿ“š Documentation
  • [ ] ๐Ÿงช Test
  • [ ] ๐Ÿ› ๏ธ Other

Related issues

  • Closes #710

Checklist

  • [x] Code follows style guide
  • [ ] Tests added
  • [ ] Documented the changes

Please explain your changes below.

prady0t avatar Aug 02 '25 08:08 prady0t

@hameerabbasi, could you review this whenever free? I've added the "Notebooks" section in nav (and it's visible, but not on the home page with an icon just like other sections). Currently, there are also some failures in the Jupyter notebook itself.

prady0t avatar Aug 02 '25 09:08 prady0t

CodSpeed Performance Report

Merging #894 will degrade performances by 44.45%

Comparing prady0t:notebooks (a2044dc) with main (3a2e703)

Summary

โŒ 1 regression
โœ… 339 untouched

:warning: Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

Benchmark BASE HEAD Change
โŒ test_index_slice[side=100-rank=2-format='gcxs'] 1.8 ms 3.2 ms -44.45%

codspeed-hq[bot] avatar Aug 02 '25 09:08 codspeed-hq[bot]

Also please rebase on master.

hameerabbasi avatar Oct 17 '25 13:10 hameerabbasi

Maybe we can just not run the notebook in docs? These dependency errors are basically because mkdocs-jupyter runs the notebook in a fresh Jupyter Kernel (not in the current env). There could be a workaround for this but I don't think running them in docs is that necessesary. Especially when we can easily open them in Google Colab from the same page.

The better approach would be to have the standalone notebook files so they do not depend on the sparse envs. I've pushed the changes with execute disabled, let me know your thoughts.

prady0t avatar Nov 04 '25 17:11 prady0t