README.md

In s-u/acumos: Acumos R interface

Acumos R Interface

Install

The easy way (recommended):

install.packages("acumos", repos=c("http://cloud.r-project.org","http://rforge.net"), dep=T)

Alternatively, to install from sources: you have to install all dependent packages from CRAN first then

git clone [e-mail]:att/R-acumos.git acumos
R CMD build acumos
R CMD INSTALL acumos_*.tar.gz

Usage

Create a component

To create a deployment component, use acumos::compose() with the functions to expose. If type specs are not defined, they default to c(x="character").

The component consists of a bundle component.amc which is a ZIP file with meta.json defining the component and its metadata, component.bin the binary payload and component.proto with the protobuf specs.

Please consult R documentation page for details, i.e., use ?compose in R or see

https://rforge.net/doc/packages/acumos/compose.html

Deploy a component

To run the component you have to create a runtime.json file with at least {"input_port":8100} or similar to define which port the component should listen to. If there are output components there should also be a "output_url" entry to specify where to send the result to. It can be either a single entry or a list if the results are to be sent to multiple components. Example:

{"input_port":8100, "output_url":"http://127.0.0.1:8101/predict"}

With the component bundle component.amc plus runtime.json in place the component can be run using

R -e 'acumos:::run()'

The run() function can be configured to set the component directory and/or location of the component bundle. If you don't want to create a file, the runtime parameter also accepts the runtime structure, so you can also use

R -e 'acumos:::run(runtime=list(input_port=8100, output_url="http://127.0.0.1:8101/predict"))'

See also ?run in R or

https://rforge.net/doc/packages/acumos/run.html

s-u/acumos documentation built on March 16, 2020, 2:27 a.m.