Skip to content

Conversation

@prady0t
Copy link
Collaborator

@prady0t prady0t commented Aug 2, 2025

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

  • 💾 Refactor
  • 🪄 Feature
  • 🐞 Bug Fix
  • 🔧 Optimization
  • 📚 Documentation
  • 🧪 Test
  • 🛠️ Other

Related issues

Checklist

  • Code follows style guide
  • Tests added
  • Documented the changes

Please explain your changes below.

@prady0t
Copy link
Collaborator Author

prady0t commented Aug 2, 2025

@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.

@codspeed-hq
Copy link

codspeed-hq bot commented Aug 2, 2025

CodSpeed Performance Report

Merging #894 will degrade performances by 44.45%

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

Summary

❌ 1 regression
✅ 339 untouched

⚠️ 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%

Copy link
Collaborator

@hameerabbasi hameerabbasi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It seems like matplotlib needs to be added to the docs dependencies.

@hameerabbasi
Copy link
Collaborator

Also please rebase on master.

@prady0t
Copy link
Collaborator Author

prady0t commented Nov 4, 2025

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.

Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
Signed-off-by: Pradyot Ranjan <99216956+pradyotRanjan@users.noreply.github.com>
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.

Include notebooks in documentation

2 participants