Skip to main content

python client for the Roboflow application

Project description

Roboflow Python Library


roboflow logo

WebsiteDocsBlogTwitterLinkedinUniverse

Roboflow makes managing, preprocessing, augmenting, and versioning datasets for computer vision seamless. This is the official Roboflow python package that interfaces with the Roboflow API. Key features of Roboflow:

Installation:

To install this package, please use Python 3.6 or higher. We provide three different ways to install the Roboflow package to use within your own projects.

Install from PyPi (Recommended):

pip install roboflow

Install from Source:

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

Quickstart

import roboflow

# Instantiate Roboflow object with your API key
rf = roboflow.Roboflow(api_key=YOUR_API_KEY_HERE)

# List all projects for your workspace
workspace = rf.workspace()

# Load a certain project, workspace url is optional
project = rf.project("PROJECT_ID")

# List all versions of a specific project
project.versions()

# Upload image to dataset
project.upload("UPLOAD_IMAGE.jpg")

# Retrieve the model of a specific project
project.version("1").model

# predict on a local image
prediction = model.predict("YOUR_IMAGE.jpg")

# Predict on a hosted image
prediction = model.predict("YOUR_IMAGE.jpg", hosted=True)

# Plot the prediction
prediction.plot()

# Convert predictions to JSON
prediction.json()

# Save the prediction as an image
prediction.save(output_path='predictions.jpg')

Project details


Release history Release notifications | RSS feed

This version

0.2.0

Download files

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

Source Distribution

roboflow-0.2.0.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

roboflow-0.2.0-py2-none-any.whl (24.1 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: roboflow-0.2.0.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4

File hashes

Hashes for roboflow-0.2.0.tar.gz
Algorithm Hash digest
SHA256 15bd9dfdfda9bfe1ce4a7fefd0309c937e4ccbf6aef528ccf574ec38b9cfb3fb
MD5 56cde761c709db922a9cc57993b46ed1
BLAKE2b-256 428978bc353f6bb7296a86892b85bb5cce49d6debe35b8ad76b5fcf5befe51ac

See more details on using hashes here.

File details

Details for the file roboflow-0.2.0-py2-none-any.whl.

File metadata

  • Download URL: roboflow-0.2.0-py2-none-any.whl
  • Upload date:
  • Size: 24.1 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.4

File hashes

Hashes for roboflow-0.2.0-py2-none-any.whl
Algorithm Hash digest
SHA256 489e9b472bb686afaba4c79024f51d722c3b484888687136e332b0ce347c0593
MD5 0ef53a7b5d0d3ad1e8b950ece1f2dbcf
BLAKE2b-256 1bc8a9afa686ec162252cd489bca2fb8d4e992b3de795efeb1f5ff9933f11ab7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page