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.1.5

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.1.5.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

roboflow-0.1.5-py2-none-any.whl (24.0 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: roboflow-0.1.5.tar.gz
  • Upload date:
  • Size: 14.3 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.1.5.tar.gz
Algorithm Hash digest
SHA256 37e2c417e5703d500b4b7b20b048d55b30b66bd69fdb40d10f2d4cc740c57672
MD5 3539a483f6d42cc5f32a8d415cc072fc
BLAKE2b-256 6fa4b034631fbc98ff1a826645e4c835d28594bba47a17f72bb46783c6d38c39

See more details on using hashes here.

File details

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

File metadata

  • Download URL: roboflow-0.1.5-py2-none-any.whl
  • Upload date:
  • Size: 24.0 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.1.5-py2-none-any.whl
Algorithm Hash digest
SHA256 a2aebd77ed3d1d6c64184f4d8e7ec60765c1ef82dd65ea87836b2b40a6069ad9
MD5 6cb8cfc0818913d71fa1121ed056bd95
BLAKE2b-256 19c9504665357254741d404025d69d6737dcc86f24677ef3291fc729eeb8a5e7

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