Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Colab example run #69

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

AMITKESARI2000
Copy link
Contributor

Basic Colab example notebook, can be updated and modified by you as you like. https://colab.research.google.com/drive/1Bp4_v5SNU1anDDEDkvA1FLnqGIfxM7ov?usp=sharing

Basic Colab example notebook, can be updated and modified by you as you like. https://colab.research.google.com/drive/1Bp4_v5SNU1anDDEDkvA1FLnqGIfxM7ov?usp=sharing
@juanmc2005 juanmc2005 self-requested a review July 25, 2022 11:25
@juanmc2005 juanmc2005 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Jul 25, 2022
@juanmc2005
Copy link
Owner

Hi @AMITKESARI2000,

Thank you for opening this PR, adding a colab notebook is a great idea!
I would prefer to put the focus on the Python API instead of the terminal, as it is best suited to colab and is more flexible. Also, it would be best to define an outline so that the chapters in the notebook can grow in complexity, covering a basic usage in the beginning and a more advanced one at the end, like plugging custom models and tuning hyper-parameters.

Maybe something like:

  • Installation
  • Choosing an audio source
  • Running the default pipeline
  • Customizing the default pipeline
  • Swapping models (e.g. replacing segmentation with oracle, or using random embeddings, something simple)
  • Tuning hyper-parameters

Note that some features will be inaccessible from colab (as you also mention in the notebook), like real-time plotting and streaming from the microphone.

@@ -121,6 +121,8 @@ inference(pipeline, audio_source)

For faster inference and evaluation on a dataset we recommend to use `Benchmark` instead (see our notes on [reproducibility](#reproducibility)).

[Colab example notebook](https://colab.research.google.com/drive/1Bp4_v5SNU1anDDEDkvA1FLnqGIfxM7ov?usp=sharing)
Copy link
Owner

Choose a reason for hiding this comment

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

I would prefer to add the link as a badge at the top of the README.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants