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

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

Uploaded Source

Built Distribution

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

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

Uploaded Python 2

File details

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

File metadata

  • Download URL: roboflow-0.1.8.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.8.tar.gz
Algorithm Hash digest
SHA256 43bac2cefc756a7aefb7b2f14c5a0e642ca6cebfb589269680ccd6a37501bf2f
MD5 a30674cf2cc127238645a35983bbc862
BLAKE2b-256 7b1860506d69086d97122568dcc4f2d0a15361d5a9193c6f5f248b9acd74712c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: roboflow-0.1.8-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.1.8-py2-none-any.whl
Algorithm Hash digest
SHA256 b3e41a0e6cd07fd8676f899891444008bf2217708eebf59b300606ec6569bafc
MD5 1e5bd76a200ed771857f9233788ed10a
BLAKE2b-256 16dac839b3e0709168581fd4b413ae3e50611e4f5c2ecad245d3a305666cd617

See more details on using hashes here.

Supported by

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