Roboflow Python Package

Roboflow provides everything you need to build and deploy computer vision models. roboflow-python is the official Roboflow Python package. roboflow-python enables you to interact with models, datasets, and projects hosted on Roboflow.

With this Python package, you can:

  1. Create and manage projects;
  2. Upload images, annotations, and datasets to manage in Roboflow;
  3. Start training vision models on Roboflow;
  4. Run inference on models hosted on Roboflow, or Roboflow models self-hosted via Roboflow Inference, and more.

The Python package is documented on the official Roboflow documentation site. If you are developing a feature for this Python package, or need a full Python library reference, refer to the package developer documentation.

💻 Installation

You will need to have Python 3.8 or higher set up to use the Roboflow Python package.

Run the following command to install the Roboflow Python package:

pip install roboflow
Install from source

You can also install the Roboflow Python package from source using the following commands:

git clone https://github.com/roboflow-ai/roboflow-python.git
cd roboflow-python
python3 -m venv env
source env/bin/activate
pip3 install -r requirements.txt
Command line tool

By installing roboflow python package you can use some of its functionality in the command line (without having to write python code). See CLI-COMMANDS.md

🚀 Getting Started

To use the Roboflow Python package, you first need to authenticate with your Roboflow account. You can do this by running the following command:

import roboflow
roboflow.login()
Authenticate with an API key

You can also authenticate with an API key by using the following code:

import roboflow

rf = roboflow.Roboflow(api_key="")

Learn how to retrieve your Roboflow API key.

Quickstart

Below are some common methods used with the Roboflow Python package, presented concisely for reference. For a full library reference, refer to the Roboflow API reference documentation.

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
)

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

# upload a dataset
workspace.upload_dataset(
    dataset_path="./dataset/",
    num_workers=10,
    dataset_format="yolov8", # supports yolov8, yolov5, and Pascal VOC
    project_license="MIT",
    project_type="object-detection"
)

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

# run inference
model = version.model

img_url = "https://media.roboflow.com/quickstart/aerial_drone.jpeg"

predictions = model.predict(img_url, hosted=True).json()

print(predictions)

Library Structure

The Roboflow Python library is structured using the same Workspace, Project, and Version ontology that you will see in the Roboflow application.

import roboflow

roboflow.login()

rf = roboflow.Roboflow()

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

The workspace, project, and version parameters are the same that you will find in the URL addresses at app.roboflow.com and universe.roboflow.com.

Within the workspace object you can perform actions like making a new project, listing your projects, or performing active learning where you are using predictions from one project's model to upload images to a new project.

Within the project object, you can retrieve metadata about the project, list versions, generate a new dataset version with preprocessing and augmentation settings, train a model in your project, and upload images and annotations to your project.

Within the version object, you can download the dataset version in any model format, train the version on Roboflow, and deploy your own external model to Roboflow.

🏆 Contributing

We would love your input on how we can improve the Roboflow Python package! Please see our contributing guide to get started. Thank you 🙏 to all our contributors!


Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.4.2)

Owner

PyPI data
Data sourced directly from PyPI's database.

4 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for robolake from gravatar.com robolake Avatar for sachin-roboflow from gravatar.com sachin-roboflow Avatar for SkalskiP from gravatar.com SkalskiP
+1 more Avatar for tony_roboflow from gravatar.com tony_roboflow

Credits

Author: Roboflow

License

Apache Software License

Requires

Python >=3.8

Provides Extra

desktop dev

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

roboflow-1.1.31.tar.gz (63.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

roboflow-1.1.31-py3-none-any.whl (75.6 kB view details)

Uploaded Python 3

File details

Details for the file roboflow-1.1.31.tar.gz.

File metadata

  • Download URL: roboflow-1.1.31.tar.gz
  • Upload date:
  • Size: 63.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.8.18

File hashes

Hashes for roboflow-1.1.31.tar.gz
Algorithm Hash digest
SHA256 0119657612061484f2dac6f8d038731f52c11008c31bbba9e33e11afa5ab31ad
MD5 cb98c57c92b1241d5b9f1e33085aa513
BLAKE2b-256 2c00a2b81bedef4d67e3d69fb3665718fdc28e9b914bf9bc345dee307fd07858

See more details on using hashes here.

File details

Details for the file roboflow-1.1.31-py3-none-any.whl.

File metadata

  • Download URL: roboflow-1.1.31-py3-none-any.whl
  • Upload date:
  • Size: 75.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.8.18

File hashes

Hashes for roboflow-1.1.31-py3-none-any.whl
Algorithm Hash digest
SHA256 62dfbe651d150d64e6acf69508b2cb6fe31462218fbd913e4658915d94ea4835
MD5 e2bab066e1907d9229762ff1c8a310b7
BLAKE2b-256 8f9101f666e3ca38dd3118efaadcc66f871e8e0d15018dd7914e219cb42f12d9

See more details on using hashes here.

Release history Release notifications | RSS feed

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.13

2 files

1.3.12

2 files

1.3.11

2 files

1.3.10

2 files

1.3.9

2 files

1.3.8

2 files

1.3.7

2 files

1.3.6

2 files

1.3.5

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.2.16

2 files

1.2.15

2 files

1.2.14

2 files

1.2.13

2 files

1.2.12

2 files

1.2.11

2 files

1.2.10

2 files

1.2.9

2 files

1.2.8

2 files

1.2.7

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

1.1.67

2 files

1.1.66

2 files

1.1.65

2 files

1.1.64

2 files

1.1.63

2 files

1.1.62

2 files

1.1.61

2 files

1.1.60

2 files

1.1.58

2 files

1.1.57

2 files

1.1.56

2 files

1.1.55

2 files

1.1.54

2 files

1.1.53

2 files

1.1.51

2 files

1.1.50

2 files

1.1.49

2 files

1.1.48

2 files

1.1.47

2 files

1.1.46

2 files

1.1.45

2 files

1.1.44

2 files

1.1.43

2 files

1.1.42

2 files

1.1.41

2 files

1.1.40

2 files

1.1.39

2 files

1.1.38

2 files

1.1.37

2 files

1.1.36

2 files

1.1.35

2 files

1.1.34

2 files

1.1.33

2 files

1.1.32

2 files

This release

1.1.31 This release

2 files

1.1.30

2 files

1.1.29

2 files

1.1.28

2 files

1.1.27

2 files

1.1.26

2 files

1.1.25

2 files

1.1.24

2 files

1.1.23

2 files

1.1.22

2 files

1.1.21

2 files

1.1.20

2 files

1.1.19

2 files

1.1.18

2 files

1.1.17

2 files

1.1.16

2 files

1.1.15

2 files

1.1.14

2 files

1.1.13

2 files

1.1.12

2 files

1.1.11

3 files

1.1.10

2 files

1.1.9

2 files

1.1.8

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.9

2 files

1.0.8

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.2.34

2 files

0.2.32

2 files

0.2.31

2 files

0.2.30

2 files

0.2.29

2 files

0.2.28

2 files

0.2.27

2 files

0.2.26

2 files

0.2.25

2 files

0.2.24

2 files

0.2.23

2 files

0.2.22

2 files

0.2.21

2 files

0.2.20

2 files

0.2.19

2 files

0.2.18

2 files

0.2.17

2 files

0.2.16

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

Yanked

0.2.12

2 files

Yanked reason: Major regression

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.0.2

1 file

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page