Skip to content

Commit

Permalink
👋 hello section added to README.md, 🚀 Feature Request template added
Browse files Browse the repository at this point in the history
  • Loading branch information
SkalskiP committed Nov 20, 2022
1 parent eefa373 commit 6d28d3b
Show file tree
Hide file tree
Showing 4 changed files with 56 additions and 7 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
Please search the [issues](https://github.com/roboflow-ai/notebooks/issues) to see if a similar bug report already exists.
options:
- label: >
I have searched the Roboflow Notebooks [issues](https://github.com/ultralytics/yolov5/issues) and found no similar bug report.
I have searched the Roboflow Notebooks [issues](https://github.com/roboflow-ai/notebooks/issues) and found no similar bug report.
required: true
- type: textarea
Expand Down Expand Up @@ -45,7 +45,7 @@ body:
- OS: Ubuntu 20.04
- Python: 3.9.0
validations:
required: false
required: true

- type: textarea
attributes:
Expand Down
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: 🚀 Feature Request
description: Suggest a Roboflow Notebooks idea
# title: " "
labels: [enhancement]
body:
- type: markdown
attributes:
value: |
Thank you for submitting a Roboflow Notebooks 🚀 Feature Request!
- type: checkboxes
attributes:
label: Search before asking
description: >
Please search the [issues](https://github.com/roboflow-ai/notebooks/issues) to see if a similar bug report already exists.
options:
- label: >
I have searched the Roboflow Notebooks [issues](https://github.com/roboflow-ai/notebooks/issues) and found no similar bug report.
required: true
- type: textarea
attributes:
label: Description
description: A short description of your tutorial idea.
placeholder: |
What tutorial do you think we should add to Roboflow Notebooks?
validations:
required: true

- type: textarea
attributes:
label: Additional
description: Anything else you would like to share?

- type: checkboxes
attributes:
label: Are you willing to submit a PR?
description: >
(Optional) We encourage you to submit a [Pull Request](https://github.com/roboflow-ai/notebooks/pulls) (PR) to help improve Roboflow Notebooks for everyone, especially if you have a good understanding of how to implement a fix or feature.
See the Roboflow Notebooks [Contributing Guide](https://github.com/roboflow-ai/notebooks/blob/main/CONTRIBUTING.md) to get started.
options:
- label: Yes I'd like to help by submitting a PR!
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,21 @@
</br>
</p>

## 👋 hello

Over the years we created dozens of Computer Vision tutorials. This repository contains Jupyter Notebooks linked to
Roboflow Blogpost and used in our YouTube videos. Please keep in mind that it is still under construction 🚧. In the
meantime, you can find a full list of our tutorials [here](https://models.roboflow.com/).

## 🚀 tutorials

<!--- AUTOGENERATED-NOTEBOOKS-TABLE -->
<!---
WARNING: DO NOT EDIT THIS TABLE MANUALLY. IT IS AUTOMATICALLY GENERATED.
HEAD OVER TO CONTRIBUTING.MD FOR MORE DETAILS ON HOW TO MAKE CHANGES PROPERLY.
-->
| **notebook** | **open in colab or kaggle** | **complementary materials** | **repository** |
|:-------------|:---------------------------:|:---------------------------:|:--------------:|
| **notebook** | **open notebook in colab or kaggle** | **complementary materials** | **repository** |
|:-------------|:------------------------------------:|:---------------------------:|:--------------:|
| [train-yolov5-object-detection-on-custom-data](https://github.com/roboflow-ai/notebooks/blob/main/notebooks/train-yolov5-object-detection-on-custom-data.ipynb) | [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/roboflow-ai/notebooks/blob/main/notebooks/train-yolov5-object-detection-on-custom-data.ipynb) [![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/roboflow-ai/notebooks/blob/main/notebooks/train-yolov5-object-detection-on-custom-data.ipynb) | [![Roboflow](https://raw.githubusercontent.com/roboflow-ai/notebooks/main/assets/badges/roboflow-blogpost.svg)](https://blog.roboflow.com/how-to-train-yolov5-on-a-custom-dataset) [![YouTube](https://badges.aleen42.com/src/youtube.svg)](https://youtu.be/watch?v=MdF6x6ZmLAY) | [![YouTube](https://badges.aleen42.com/src/github.svg)](https://github.com/ultralytics/yolov5) |
| [train-yolov5-classification-on-custom-data](https://github.com/roboflow-ai/notebooks/blob/main/notebooks/train-yolov5-classification-on-custom-data.ipynb) | [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/roboflow-ai/notebooks/blob/main/notebooks/train-yolov5-classification-on-custom-data.ipynb) [![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/roboflow-ai/notebooks/blob/main/notebooks/train-yolov5-classification-on-custom-data.ipynb) | [![Roboflow](https://raw.githubusercontent.com/roboflow-ai/notebooks/main/assets/badges/roboflow-blogpost.svg)](https://blog.roboflow.com/train-yolov5-classification-custom-data) [![YouTube](https://badges.aleen42.com/src/youtube.svg)](https://www.youtube.com/watch?v=DPjp9Kq4qn8) | [![YouTube](https://badges.aleen42.com/src/github.svg)](https://github.com/ultralytics/yolov5) |
| [train-yolov6-object-detection-on-custom-data](https://github.com/roboflow-ai/notebooks/blob/main/notebooks/train-yolov6-object-detection-on-custom-data.ipynb) | [![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/roboflow-ai/notebooks/blob/main/notebooks/train-yolov6-object-detection-on-custom-data.ipynb) [![Kaggle](https://kaggle.com/static/images/open-in-kaggle.svg)](https://kaggle.com/kernels/welcome?src=https://github.com/roboflow-ai/notebooks/blob/main/notebooks/train-yolov6-object-detection-on-custom-data.ipynb) | [![Roboflow](https://raw.githubusercontent.com/roboflow-ai/notebooks/main/assets/badges/roboflow-blogpost.svg)](https://blog.roboflow.com/how-to-train-yolov6-on-a-custom-dataset) [![YouTube](https://badges.aleen42.com/src/youtube.svg)](https://www.youtube.com/watch?v=fFCWrMFH2UY) | [![YouTube](https://badges.aleen42.com/src/github.svg)](https://github.com/meituan/YOLOv6) |
Expand All @@ -25,7 +31,8 @@
## 🐞 bugs & 🦸 contribution

Computer Vision moves fast! Sometimes our notebooks lag a tad behind the ever-pushing
forward libraries. If you notice that any of the notebooks is not working properly, create a [bug report](https://github.com/roboflow-ai/notebooks/issues)
forward libraries. If you notice that any of the notebooks is not working properly, create a
[bug report](https://github.com/roboflow-ai/notebooks/issues/new?assignees=&labels=bug%2Ctriage&template=bug-report.yml)
and let us know.

If you have an idea for a new tutorial we should do, create a [feature request](https://github.com/roboflow-ai/notebooks/issues).
Expand Down
4 changes: 2 additions & 2 deletions automation/autogenerate_notebooks_table.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
"-->"
]
TABLE_HEADER = [
"| **notebook** | **open in colab or kaggle** | **complementary materials** | **repository** |",
"|:-------------|:---------------------------:|:---------------------------:|:--------------:|"
"| **notebook** | **open notebook in colab or kaggle** | **complementary materials** | **repository** |",
"|:-------------|:------------------------------------:|:---------------------------:|:--------------:|"
]

NOTEBOOK_LINK_PATTERN = "[{}]({}/{})"
Expand Down

0 comments on commit 6d28d3b

Please sign in to comment.