⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Updated readme - usage of python sdk #431

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.

Sign up for GitHub

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

Open
Erol444 wants to merge 2 commits into
base: main
Choose a base branch
from
+24 −30
Open

Updated readme - usage of python sdk #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
09318cb
Updated readme - usage of python sdk
Erol444 Jan 13, 2026
0cde72e
fix(pre_commit): 🎨 auto format pre-commit hooks
pre-commit-ci[bot] Jan 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 10 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,21 +104,19 @@ Below are some common methods used with the Roboflow Python package, presented c
```python
import roboflow

roboflow.login()
# Pass API key or use roboflow.login()
rf = roboflow.Roboflow(api_key="MY_API_KEY")

rf = roboflow.Roboflow()
workspace = rf.workspace()

# create a project
rf.create_project(
project_name="project name",
project_type="project-type",
license="project-license" # "private" for private projects
# creating object detection model that will detect flowers
project = workspace.create_project(
project_name="Flower detector",
project_type="object-detection", # Or "classification", "instance-segmentation", "semantic-segmentation"
project_license="MIT", # "private" for private projects, only available for paid customers
annotation="flowers" # If you plan to annotate lillys, sunflowers, etc.
)

workspace = rf.workspace("WORKSPACE_URL")
project = workspace.project("PROJECT_URL")
version = project.version("VERSION_NUMBER")

# upload a dataset
workspace.upload_dataset(
dataset_path="./dataset/",
Expand All @@ -128,12 +126,9 @@ workspace.upload_dataset(
project_type="object-detection"
)

# upload model weights
version.deploy(model_type="yolov8", model_path=f”{HOME}/runs/detect/train/”)
version = project.version("VERSION_NUMBER")

# upload model weights - yolov10
# Before attempting to upload YOLOv10 models install ultralytics like this:
# pip install git+https://github.com/THU-MIG/yolov10.git
version.deploy(model_type="yolov10", model_path=f”{HOME}/runs/detect/train/”, filename="weights.pt")

# run inference
Expand Down
29 changes: 14 additions & 15 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,18 @@ Below are some common methods used with the Roboflow Python package, presented c
```python
import roboflow

roboflow.login()

rf = roboflow.Roboflow()

# create a project
rf.create_project(
project_name="project name",
project_type="project-type",
license="project-license" # "private" for private projects
# Pass API key or use roboflow.login()
rf = roboflow.Roboflow(api_key="MY_API_KEY")

workspace = rf.workspace()
# creating object detection model that will detect flowers
project = workspace.create_project(
project_name="Flower detector",
project_type="object-detection", # Or "classification", "instance-segmentation", "semantic-segmentation"
project_license="MIT", # "private" for private projects, only available for paid customers
annotation="flowers" # If you plan to annotate lillys, sunflowers, etc.
)

workspace = rf.workspace("WORKSPACE_URL")
project = workspace.project("PROJECT_URL")
version = project.version("VERSION_NUMBER")

# upload a dataset
workspace.upload_dataset(
dataset_path="./dataset/",
Expand All @@ -92,8 +89,10 @@ workspace.upload_dataset(
project_type="object-detection"
)

# upload model weights
version.deploy(model_type="yolov8", model_path=f”{HOME}/runs/detect/train/”)
version = project.version("VERSION_NUMBER")

# upload model weights - yolov10
version.deploy(model_type="yolov10", model_path=f”{HOME}/runs/detect/train/”, filename="weights.pt")

# run inference
model = version.model
Expand Down
Loading