pfnet-research/menoh-ruby

Ruby binding for Menoh DNN inference library

Menoh Ruby Extension

This is a Ruby extension of Menoh; an ONNX runtime engine developed by @okdshin and their team @pfnet-research.

Installation

You need ruby-dev, bundler, rake-compiler to install this extension.

$ sudo apt install ruby-dev
$ sudo gem install bundler
$ sudo gem install rake-compiler

And add this line to your application's Gemfile:

gem 'menoh'

And then execute:

$ bundle

Or install it yourself as:

$ gem install menoh

Usage

Please see Menoh tutorial and menoh-ruby tutorial. And we have some examples on this repository.

Development

After checking out the repo, run bin/setup to install ruby dependencies. Then, run rake test to run the tests. 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.

Docker

You can develop on docker. For details, please refer to Dockerfile.

$ export IMAGE_VERSION=0.0.0 # please specify version
$ sudo -E docker build -t menoh-ruby:$IMAGE_VERSION `pwd`
$ sudo -E docker run -it --name menoh-ruby-test -v $(pwd):/opt/menoh-ruby --entrypoint /bin/bash menoh-ruby:$IMAGE_VERSION
＄ cd /opt/menoh-ruby
＄ rake && rake install

attach after stop

sudo docker start menoh-ruby-test bash
sudo docker attach menoh-ruby-test

Vagrant

You can also set up the development environment by using Vagrant. The details are available on Vagrantfile.

$ vagrant up
$ vagrant ssh
$ cd /vagrant

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/pfnet-research/menoh-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Menoh Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

menoh-ruby's Issues

remove rake-compiler

The gem package rake-compiler is needed only for multi environmental deployment.
This library simply builds a native extension, so it can be independent from rake-compiler.

refine class names

The class name Menoh::Menoh is little bit redundant.

Menoh::MenohModel#run tensor representation asymmetricity

Menoh::MenohModel#run takes input tensors as flattened arrays while it returns tensors as nested arrays. This looks asymmetric and not intuitive.