Contents

# GcfRuby : simple predictions with google cloud functions

This gem allows interaction within ruby code with various APIs hosted in google cloud functions. It is primarly designed to predict results of machine learning models and works synchronously (for light predictions) or asynchronously (for heavier predictions). 

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'gcf_ruby'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install gcf_ruby

## Usage

After installing the gem, complete the file in  `config/initializers/gcf_ruby.rb` with required `api_url` (for webhooks) and `api_bearer` for authentication.

Two methods are available (as of 19/04/2021) : 

- `predict(model_name, params)` which returns synchronously the result of the model with the corresponding model_name.
- `predict_async` which returns asynchronously the result of the model. It requires a webhook url (set in `api_url`) on which the response will be sent.

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Flatlooker/gcf_ruby.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
gcf_ruby-0.1.0	README.md