Project

eclaircir

0.0
No commit activity in last 3 years
No release in over 3 years
Ruby Clarifai API wrapper that aims to be complete, tested and covered
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

~> 0.14.0
~> 1.0
 Project Readme

Eclaircir

Eclaircir is a french synonym for 'Clarify' and seemed relevant as a name for the gem.

This gem aims to be a Clarifai APIv2 wrapper that is complete, tested and covered.

Build Status Coverage Status

Install

gem install eclaircir

Requirements

  • Ruby 2.0.0 or higher
  • HTTParty
  • Virtus

Examples

...

Contributing

  • Fork the project
  • Run bundle install --path .bundle
  • Run bundle exec rake spec
  • Add tests for your feature (the TDD way!)
  • Implement your feature
  • Run tests again
  • Commit (excluding the Rakefile or the Version.rb if you want to be merged)
  • Send a pull request

How can I help?

The Roadmap for V1 is to provide a completely usable API wrapper to do common tasks on Clarifai.

Here's an extract from the TODO:

V1.0

  • Authentication
    • API Key Management
    • Authorization
  • Status Management
    • Modelization: Response
    • Modelization: Status
    • Modelization: Output
    • General Errors
    • Specific Errors
    • Fully manage statuses using the statuses cheatsheet
    • Response Parsing
  • Predict
    • Modelization: Input
    • Modelization: Data
    • Modelization: Concept
    • Modelization: Model
    • Support URL Requests for Images
    • Response Parsing
    • Support base 64 Requests for Images
    • Support of multiple inputs (max 128)
    • Modelization: Frame
    • Video support
  • Search
    • Add Images to search index
    • Search by concept
    • Search by image
  • Train
    • Add image with concepts
    • Model Creation
    • Model Training