Socket
Socket
Sign inDemoInstall

roboflow

Package Overview
Dependencies
35
Maintainers
9
Versions
17
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

roboflow

Roboflow.com node module


Version published
Maintainers
9
Weekly downloads
14
decreased by-33.33%

Weekly downloads

Readme

Source

Roboflow node library

Roboflow makes computer vision accessible to all developers. https://roboflow.com

This project is under active development, use at your own risk

Node Module

The node module is currently a very basic wrapper around roboflow API endpoints.

You can use it like so:

const roboflow = require("roboflow");
const workspaceInfo = roboflow.getWorkspace(workspaceUrl, apiKey);

It currently includes the following functions, which are implemented in api.js:

  • getWorkspace(workspaceUrl, apiKey)
  • getProject(workspaceUrl, projectUrl, apiKey)
  • getVersion(workspaceUrl, projectUrl, version, apiKey)
  • getFormat(workspaceUrl, projectUrl, version, format, apiKey)
  • uploadImage(filepath, projectUrl, apiKey, options)
  • detectObject(filepath, modelUrl, apiKey, options)
  • classify(filepath, modelUrl, apiKey)
  • instanceSegmentation(filepath, modelUrl, apiKey)
  • semanticSegmentation(filepath, modelUrl, apiKey)
  • embedImage(filepath, apiKey)
  • embedText(text, apiKey)

Development

Testing

The repo includes a series of jest tests to make sure the api wrapper functions work as expected. To run the tests you must setup a .env file with the following variables and run npm run test:

  • apiKey a valid roboflow api key
  • workspace a valid roboflow workspace which can be accessed with the given apiKey
  • project a valid roboflow project within the given workspace
  • version a valid version of the given roboflow project which has a model trained
  • testImage the relative path to a test image inside the __tests__ directory such as test.jpeg

Keywords

FAQs

Last updated on 13 Jul 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc