Publish to App (RapidMiner Studio Core)

Synopsis

This operator stores the given object in the RapidMiner Server App or the current RapidMiner Studio session. The stored object can be retrieved by using the Recall from App operator.

Description

The Publish to App operator can be used to store the input object in the RapidMiner Server App or the current RapidMiner Studio session. The name of the object is specified through the name parameter. The stored object can later be retrieved via the Recall from App operator by using the same name (i.e. the name that was used to store it with the Publish to App operator). When an object was stored by the Publish to App operator once, it can be recalled at any point in the RapidMiner Server App. But care should be taken that the execution order of operators is such that the Publish to App operator for an object is executed before the Recall from App operator for that object. The combination of these two operators can be used to build complex RapidMiner Server Apps, where an input object is stored once and used in completely different parts of the App later on.

Differentiation

Recall from App

The Publish to App operator is always used in combination with the Recall from App operator. The Publish to App operator stores the required object in the RapidMiner Server App and the Recall from App operator retrieves the stored object when required.

Input

  • store

    Any object can be provided here. This object will be stored in the RapidMiner Server App or the current RapidMiner Studio session.

Output

  • stored

    The object that was given as input is passed without changing to the output through this port. It is not compulsory to attach this port to any other port, the object will be cached even if this port is left without connections.

Parameters

  • nameThe name under which the input object is stored is specified through this parameter. The same name will be used for retrieving this object through the Recall from App operator. Range: string

Tutorial Processes

Introduction to Publish to App and Recall from App operators

This process uses the combination of the Publish to App and Recall from App operators to display the testing data set of the Split Validation operator. The testing data set is present in the testing subprocess of the Split Validation operator but it is not available outside the Split Validation operator.

The 'Golf' data set is loaded using the Retrieve operator. The Split Validation operator is applied on it. The test set size parameter is set to 5 and the training set size parameter is set to -1. Thus the test set in the testing subprocess will be composed of 5 examples. The Default Model operator is used in the training subprocess to train a model. The testing data set is available at the tes port of the testing subprocess. The Publish to App operator is used to store the testing data set in the RapidMiner Server App. The name and io object parameters are set to 'Testset' and 'ExampleSet' respectively. The Apply Model and Performance operator are applied in the testing subprocess later. In the main process, the Recall from App operator is used to retrieve the testing data set. The name and io object parameters of the Recall from App operator are set to 'Testset' and 'ExampleSet' respectively to retrieve the object that was cached by the Publish to App operator. The output of the Recall from App operator is connected to the result port of the process. Therefore the testing data set can be seen in the Results view.

The operator Recall from App cannot be used to retrieve objects stored with the Remember operator, and the operator Recall cannot be used to retrieve objects stored with the Publish to App operator. They do not use the same storage.

The difference to the operators Remember and Recall is that Publish to App does not only store an object for the process execution (as the Remember operator does), but for the lifetime of a RapidMiner Server App. This means that the Recall from App operator could also be part of another process in the same RapidMiner Server App and would retrieve the same object as long as the process, which remembers the object for the App, was executed beforehand.