Acumos R Client User Guide

Using the Acumos R Client

Please refer to the Acumos R Client Installation and Maintenance Guide prior to the following

Model bundle

To on-board a model in Acumos you need to create a model bundle, use acumos::compose() with the functions to expose to create it. Below is an example of how create a model bundle based on the IRIS model.

acumos::compose(predict=function(..., inputs=lapply(iris[-5], class)) print(as.character(predict(rf,,
aux = list(rf = randomForest(Species ~ ., data=iris)),name="IRIS_model", file="path/to/store/the/model/bundle/")

This model bundle contains :

  1. meta.json defining the component and their metadata,
  2. component.bin the binary payload,
  3. and component.proto with the protobuf specs.

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

If you used R under windows you could meet an issue using the acumos::compose() function due to some problems between R under windows and zip. If RTools is not installed on your windows environment, the model bundle will not be created. So please follows the installation procedure of Rtools then set your environmental variables properly, add the bin folder of Rtools to the system path.

CLI and Web on-boarding

  • CLI on-boarding

Once the model bundle is created, you can use the push() API to on-board it in Acumos. This is CLI (Command Line Interface) on-boarding.


url can be found in the ON-BOARDING MODEL page of your Acumos portal and looks like : “hotsname:port/onboarding-app/v2/models”

file :

username : your Acumos username

token : Authentication token available in the Acumos portal in your profile section

create : logical parameter (Boolean) to trigger the creation of microservice at the end of on-boarding process. By default create=TRUE, if you don’t want to create the microservice modify the value to FALSE (create =FALSE)

license : path to the license profile file : The license profile file name must be “license.json”.

You can also authenticate yourself by using the auth() API:


url can be found in the ON-BOARDING MODEL page of your Acumos portal and lokks like “hostname:port/onboarding-app/v2/auth”

username : your Acumos username

password : your Acumos password

In the Response, you will receive an authentication token to be used in the acumos::push() function like that :

  • Web on-boarding

You can also drag & drop your model bundle on the “ON-BORADING BY WEB” page in your Acumos instance, or browse you model bundle from this page. This is Web on-boarding.

You can on-board your model with a license profile, you just have to browse your license profile file or drag and drop it.

Whatever the case, CLI or WEB on-boarding, if the license profile file extension is not ‘json’ the license on-boarding will not be possible and if the name is not ‘license’ Acumos will rename your license file as license.json and you will see your license profile file as “license-1.json” in the artifacts table. If you upload a new version of your license through the portal, the license number revision will be increased by one like that “license-2.json”. To help user create the license profile file expected by Acumos a license profile editor user guide is available here : License profile editor user guide