[jamie-ons]

✨ Summary

Add the mybinder demo to the classifai README.md to make it easier to access.

📜 Changes Introduced

• Updated readme.md to have the mybinder button, pointing to https://github.com/datasciencecampus/classifai_demo main branch demo/DEMO.ipynb.

✅ Checklist

• Code passes linting with Ruff
• Security checks pass using Bandit
• API and Unit tests are written and pass using pytest
• Terraform files (if applicable) follow best practices and have been validated (terraform fmt & terraform validate)
• DocStrings follow Google-style and are added as per Pylint recommendations
• Documentation has been updated if needed

🔍 How to Test

• In github change to 6-add-mybinder-badge-to-the-repo and check the positioning of the button looks good
• Click the button and verify that it takes you to the working mybinder demo.

What it looks like for me:

Check the documenation site

1. Run uv sync to get the additional (dev) packages required
2. Run uv run quartodoc build to build the quarto markdown files
3. Run uv run quarto render to render html documentation site
4. Run uv run quarto preview to locally host the documentation site - explore it in a browser

• Ensure the button looks ok on the homepage of the documentation site.

What it looks like for me:

[jamie-ons]

I have tried multiple different formats for the button to make it more intuitive.

https://github.com/geopandas/geopandas and https://github.com/pydata/xarray simply put it at the top of their readme which i personally do not find intutative.

Out of these approaches I decided none of them were clean or intuative enough. I used https://mybinder.readthedocs.io/en/latest/howto/badges.html to create a new badge which I think is more user friendly:

[jamie-ons]

ClassifAI  

This is the current icon for testing. This works for me and hopefully for others

[lukeroantreeONS]

I think this is ready - however, suggest pausing until we put out a v1.1.2 bugfix to pin the Polars version due to incompatibility with ClassifAI @ v1.1.1