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

Add Open in Kaggle badge #1773

Merged
merged 5 commits into from
May 27, 2021
Merged

Add Open in Kaggle badge #1773

merged 5 commits into from
May 27, 2021

Conversation

pizzaz93
Copy link
Contributor

@pizzaz93 pizzaz93 commented May 24, 2021

Add Kaggle Badge that allows for opening the .ipynb as a Kaggle Notebook as seen here https://www.kaggle.com/product-feedback/152480.

πŸ› οΈ PR Summary

Made with ❀️ by Ultralytics Actions

🌟 Summary

Updates to YOLOv3 tutorial notebook adding Kaggle as an environment option.

πŸ“Š Key Changes

  • An additional button enables users to open the YOLOv3 tutorial notebook directly in Kaggle.

🎯 Purpose & Impact

  • Broader Accessibility: Provides flexibility for users to choose Kaggle, a popular data science platform, as their environment for running the tutorial.
  • User Convenience: The change simplifies transitioning to Kaggle, which might appeal to users with preferences for that platform or those seeking different computational resources.
  • Community Engagement: This could encourage more data scientists on Kaggle to experiment with Ultralytics' YOLOv3, potentially leading to greater adoption and community contributions.

add Open in Kaggle badge
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

πŸ‘‹ Hello @pizzaz93, thank you for submitting a πŸš€ PR! To allow your work to be integrated as seamlessly as possible, we advise you to:

  • βœ… Verify your PR is up-to-date with origin/master. If your PR is behind origin/master update by running the following, replacing 'feature' with the name of your local branch:
git remote add upstream https://github.com/ultralytics/yolov3.git
git fetch upstream
git checkout feature  # <----- replace 'feature' with local branch name
git rebase upstream/master
git push -u origin -f
  • βœ… Verify all Continuous Integration (CI) checks are passing.
  • βœ… Reduce changes to the absolute minimum required for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." -Bruce Lee

@glenn-jocher
Copy link
Member

@pizzaz93 thanks for the PR! I tried to click the Kaggle badge in your branch but it doesn't seem to work correctly:
https://github.com/pizzaz93/yolov3/blob/patch-1/tutorial.ipynb

@glenn-jocher
Copy link
Member

@pizzaz93 the link itself seems to work well, it just appears to be a problem with the notebook integration of the badge maybe:
https://kaggle.com/kernels/welcome?src=https://github.com/ultralytics/yolov3/blob/master/tutorial.ipynb

@glenn-jocher
Copy link
Member

@pizzaz93 we also have a seperate kaggle notebook here, though we have to keep it updated every time we have a new release here, so your link would appear to be a better solution with less maintenance:
https://www.kaggle.com/ultralytics/yolov3

@pizzaz93
Copy link
Contributor Author

In regards to it not working, is it not opening in a new window or something else?

I'm glad to hear that the badge makes things more streamlined.

@pizzaz93 pizzaz93 removed their assignment May 24, 2021
@glenn-jocher
Copy link
Member

I get these two windows before and after clicking the badge, on Chrome MacOS latest versions.
https://github.com/pizzaz93/yolov3/blob/patch-1/tutorial.ipynb

Screenshot 2021-05-25 at 10 15 44

Screenshot 2021-05-25 at 10 15 51

@pizzaz93
Copy link
Contributor Author

The badge works when you ctrl(cmd)+click to open it in a new window. I know the colab badge works without having to do that.

Open badge in same window
@pizzaz93
Copy link
Contributor Author

I added a new commit to make the badge work without having to use ctrl(cmd)+click.

@glenn-jocher
Copy link
Member

@pizzaz93 thanks the click works now!

Is there a reason for the align=\"left\" parts? The default badge is centered, so we want these two centered also, with at least a space between them I would assume.

@glenn-jocher
Copy link
Member

glenn-jocher commented May 26, 2021

@pizzaz93 that's interesting, I tried to center and space, but no luck. Instead the badges are paired one above the other:

Screenshot 2021-05-26 at 13 02 15

This is similar to the preexisting problematic badge behavior at the bottom of the notebook also. They seem to render differently in the notebook environment than in the GitHub markdown unfortunately.

Screenshot 2021-05-26 at 13 03 30

@pizzaz93
Copy link
Contributor Author

pizzaz93 commented May 26, 2021

For space between the badges I've found "br" tags to be a solution or "&nb sp;".

@glenn-jocher glenn-jocher merged commit 47ac683 into ultralytics:master May 27, 2021
@glenn-jocher
Copy link
Member

@pizzaz93 PR is merged. Thank you for your contributions!

YOLOv5 could also use a similar update if you'd like to submit a PR there!
https://github.com/ultralytics/yolov5

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.

None yet

2 participants