Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Building interactive demos for examples Β #24878

Open
@merveenoyan

Description

@merveenoyan

Describe the issue linked to the documentation

This is not an issue but rather a good-to-have feature for documentation and this issue is more of a discussion.

It would be nice to have links to or embedding interactive demos made with Gradio inside documentation.
I've built two apps that you might see how it looks like:

We can have below demo (but more official version πŸ˜…) embedded in your documentation.
Ekran Resmi 2022-11-10 15 11 41

The current workflow for users is to download python code or run binder. This reduces amount of work in this workflow too!
If you think embedded demos is a bit overkill what we could do is to create these demos and host them on Spaces and put link to Space instead (like it is with Keras examples or kornia examples, you can see them here and here, they're linked from their tutorials on both Keras.io/examples and Kornia docs) We will also host the Spaces in better hardware (8 vCPU 32 GiB RAM) to make sure it's always running and all good. ✨

You can see how it's implemented in Kornia for rst docs here. It looks like this inside Kornia docs.

Ekran Resmi 2022-11-10 15 15 08

As for Keras, we just put a redirection link inside docs since their document generation is more layered.
Ekran Resmi 2022-11-10 15 09 57

We definitely want to reduce the core maintainers' workflow so what would be cool is that we (team at Gradio & community) will be developing the demos and maintaining them through GitHub actions such that they will not break every time there's a breaking change in sklearn (this happens rarely, though πŸ™‚)

Hoping to see how we could collaborate!

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions