search

AtomScott / SportsLabKit

A python package for turning sports video into csv files
https://sportslabkit.rtfd.io
GNU General Public License v3.0
237 stars 18 forks source link

Template Google Colab Notebooks for Comprehensive Video Analysis #123

Open JorisVillaseque opened 1 year ago

JorisVillaseque commented 1 year ago

Search before asking

Description

Hello, I hope you've been well since yesterday aha! I wanted to put forth a suggestion that I believe could greatly benefit the user community of SportLabsKit. Have you considered setting up template Google Colab notebooks that offer a comprehensive example of processing a video from start to finish? I believe it would be beneficial for the user community if SportLabsKit provided template Google Colab notebooks that offer a comprehensive walkthrough of processing a video from start to finish.

Use case

This could encompass steps like:

Importing a video. Tracking players and the ball. Displaying tracking results superimposed on the video. Defining the field boundaries. Analyzing data and visualizing it on a 2D pitch. Drawing conclusions based on the analysis. Roboflow's educational notebooks can serve as an inspiration: Roboflow Notebook Link

Additional

I understand that not all functionalities of SportLabsKit are fully polished. However, having iterative versions of such a Colab notebook, updated with each enhancement, could be a practical way to:

Facilitate quick testing and refinement. Speed up development. Act as an invaluable educational resource, thus lowering the entry barrier. Having worked with computer vision for some time, I see a vast potential in SportLabsKit. I'm willing to contribute, be it in drafting, testing, or other aspects, to bring this suggestion to fruition.

Thank you for considering this proposal. Looking forward to the community's feedback!

Warm regards, Joris

Are you willing to submit a PR?

AtomScott commented 1 year ago

Thanks for your suggestion about Google Colab notebooks. I agree, it would be beneficial for both new users and development.

Roboflow and @skalskip92 are indeed good references. It seems like every day he's got a new tutorial going viral.

We had a notebook button before, but synchronization (keeping the colab notebooks up date) was an issue. But something like GitHub to Colab might be a solution. I've added what this could look like in the notebook below (note: I've branched it to docs/colab-button ): https://github.com/AtomScott/SportsLabKit/blob/7d88ebc53cd7a91fe1558747366775cda8bb15f8/notebooks/01_get_started/installation.ipynb

I appreciate your willingness to contribute. How about we start by converting existing notebooks to Colab and see if they run? I can help debug any issues that pop up.

JorisVillaseque commented 1 year ago

Hey AtomScott,

Awesome to hear back from you, and super stoked that you're into the idea of Google Colab notebooks!

Totally agree with you on the syncing issues and the inspirational references you mentioned. I've been checking out the notebooks you shared, and they look solid.

Exciting news—I'm planning to dive into some iterations over the weekend. Can't wait to start converting and optimizing the existing notebooks for Colab. Looking forward to teaming up to squash any bugs and make these educational resources even better.

Thanks for being open to this collab (pun intended 😄). Super excited to contribute to the SportLabsKit community!

Cheers, Joris

AtomScott commented 1 year ago

Great to hear you're on board with the Colab notebooks. I'm sure it'll be beneficial for a lot of people!

Before we dive in, a couple of guidelines:

  1. Branching: Please work in a separate branch named something like colab-notebooks. We want to keep the main branch clean!
  2. PR Reviews: I'll be reviewing the pull requests. If everything checks out, we'll merge it in👍

Just a heads up, my responses might be a bit slower over the weekends. Cheers!