RapidMiner

https://docs.rapidminer.com/
Admin
RapidMiner is a comprehensive AI and data science platform offering visual workflow design, Python...
Tokens:730,432
Snippets:10,271
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install libraries with uv

Source: https://docs.rapidminer.com/latest/applications/altair-ai-edge/ai-edge-python.html

Example command to install specific Python libraries into an environment using the uv prefix.

```bash
uv pip install onnxruntime onnxruntime_extensions pandas numpy
```

--------------------------------

### Add custom software to image

Source: https://docs.rapidminer.com/latest/hub/manage/image-reference/create-custom-image.html

Example Dockerfile showing how to install packages and copy custom binaries into the image.

```dockerfile
FROM rapidminer/rapidminer-jobagent:<version>
USER 0
RUN apt-get update && apt-get install -y curl
COPY ./custom-internal-software /usr/local/bin/custom-internal-software
RUN chmod +x /usr/local/bin/custom-internal-software
```

--------------------------------

### Install the extension

Source: https://docs.rapidminer.com/latest/developers/extensions/create/individualizing-settings/index.html

Executes the Gradle task to install the extension into the local environment.

```bash
./gradlew installExtension
```

--------------------------------

### Initialize and Start RapidMiner Platform Stack

Source: https://docs.rapidminer.com/latest/hub/manage/upgrade/index.html

Commands to initialize the deployment stack and monitor the progress of the setup process.

```bash
docker-compose up -d rm-init-svc
```

```bash
docker-compose logs rm-init-svc
```

```bash
docker-compose up -d
```

--------------------------------

### Start Altair AI Hub Deployment Initialization

Source: https://docs.rapidminer.com/latest/hub/install/docker-compose/change-default-port.html

Run this command to initialize the deployment. This is a preliminary step before starting the main services.

```bash
docker compose up -d deployment-init
```

--------------------------------

### tutorial.properties Example

Source: https://docs.rapidminer.com/latest/developers/extensions/custom-tutorials.html

Defines the name and description for an individual tutorial. This file must also be encoded as ISO-8859-1.

```properties
template.name=My first tutorial
template.description=This is my first tutorial.
```

--------------------------------

### Define custom Dockerfile

Source: https://docs.rapidminer.com/latest/hub/manage/image-reference/create-custom-image.html

Example Dockerfile configuration to install curl on a Debian-based image.

```dockerfile
FROM rapidminer/rapidminer-jobagent:<version>
USER 0
RUN apt-get update && apt-get install -y curl
```

--------------------------------

### Start Main Deployment Initialization

Source: https://docs.rapidminer.com/latest/hub/install/docker-compose/external-agents.html

Initiate the main deployment process, which generates necessary certificate files (JKS, deb, RH) into the ssl folder.

```bash
docker-compose up -d deployment-init
```

--------------------------------

### Tutorial: Storing an ExampleSet

Source: https://docs.rapidminer.com/latest/studio/operators/data_access/store.html

This tutorial demonstrates how to use the Store operator to save an ExampleSet to the repository.

```APIDOC
## Tutorial: Storing an ExampleSet using the Store operator

This Process shows how the _Store_ operator can be used to store an ExampleSet. The 'Golf' data set and the 'Golf-Testset' data are loaded using the _Retrieve_ operator. These ExampleSets are merged using the _Append_ operator. The resultant ExampleSet is named 'Golf-Complete' and stored using the _Store_ operator. The stored ExampleSet is used in the third Example Process.
```

--------------------------------

### Build and Install Extension with Gradle

Source: https://docs.rapidminer.com/latest/developers/extensions/index.html

Use the `installExtension` Gradle task to build and install your extension into Altair AI Studio. Ensure you have completed the project setup and configuration before running this task.

```bash
gradlew installExtension
```

--------------------------------

### Initialize a new extension project

Source: https://docs.rapidminer.com/latest/developers/python-sdk/getting-started.html

Create a project directory and run the initialization command to generate the default structure.

```bash
mkdir sample-extension
cd sample-extension
create-extension
```

--------------------------------

### Initialize Platform Deployment

Source: https://docs.rapidminer.com/latest/hub/install/docker-compose

Commands to start the initialization container and monitor its progress.

```bash
docker compose up -d deployment-init
```

```bash
docker compose logs -f deployment-init
```

--------------------------------

### Fielded Search - Repository Modified Date (Before)

Source: https://docs.rapidminer.com/latest/studio/getting-started/global-search

Finds entries modified before a specific date. Use the wildcard '*' for the start of the range. Example: 'modified:[* TO 2014]'.

```lucene
modified:[* TO 2014]
```

--------------------------------

### Proceeding to the Next Tutorial

Source: https://docs.rapidminer.com/latest/developers/extensions/custom-tutorials.html

To automatically open the next tutorial after the current one finishes, include the <nextTutorial> tag at the end of the steps.xml file.

```xml
<nextTutorial>START NEXT TUTORIAL</nextTutorial>
```

--------------------------------

### Configure tutorial properties

Source: https://docs.rapidminer.com/latest/developers/extensions/custom-tutorials.html

The tutorial.properties file provides metadata for an individual tutorial.

```properties
tutorial.name=First tutorial
tutorial.description=A minimal tutorial.
```

--------------------------------

### Filter Example Range Operator

Source: https://docs.rapidminer.com/latest/studio/operators/blending/examples/filter/filter_example_range.html

This operator selects which examples (i.e. rows) of an ExampleSet should be kept and which examples should be removed. Examples within the specified index range are kept, remaining examples are removed.

```APIDOC
## Filter Example Range Operator

### Description
This operator selects which examples (i.e. rows) of an ExampleSet should be kept and which examples should be removed. Examples within the specified index range are kept, remaining examples are removed.

### Method
(Not applicable, this is an operator description)

### Endpoint
(Not applicable, this is an operator description)

### Parameters
#### Path Parameters
(None)

#### Query Parameters
(None)

#### Request Body
(None)

### Input
* (Data table): An ExampleSet.

### Output
* (Data table): A new ExampleSet including only the examples that are within the specified index range.
* (Data table): The original ExampleSet passed through without changes.

### Parameters
* **first example** (integer) - The lower bound of the index range. Examples within this index range are delivered to the output port. Examples outside this index range are discarded.
* **last example** (integer) - The upper bound of the index range. Examples within this index range are delivered to the output port. Examples outside this index range are discarded.
* **invert filter** (boolean) - If this parameter is set to true, it acts as a NOT gate, it reverses the selection. In that case all the selected examples are removed and previously removed examples are selected. For example if the _first example_ parameter is set to 1 and the _last example_ parameter is set to 10. Then the output port will deliver an ExampleSet with all examples other than the first ten examples.

### Request Example
(Not applicable, this is an operator description)

### Response
#### Success Response (200)
(Not applicable, this is an operator description)

#### Response Example
(Not applicable, this is an operator description)
```

--------------------------------

### Register Sample Tutorial in Java

Source: https://docs.rapidminer.com/latest/developers/extensions/custom-tutorials.html

Extend the `initPlugin()` method to register a specific tutorial by its name after registering resource sources. This makes the tutorial available through the tutorial registry.

```java
public static void initPlugin() {
    // register extension resources
    Tools.addResourceSource(new ResourceSource(PluginInitMyExtension.class.getClassLoader(), 
        "org/myorg/myextension/"));
    // register sample tutorial
    TutorialRegistry.INSTANCE.register("sample");
}
```

--------------------------------

### AI Studio Core Operator

Source: https://docs.rapidminer.com/latest/studio/operators/blending/examples/sort/sort_by_pareto_rank.html

This operator sorts the given example set according a set of attributes such that dominated examples will be sorted after non-dominated examples.

```APIDOC
## AI Studio Core Operator

### Description
This operator sorts the given example set according a set of attributes such that dominated examples will be sorted after non-dominated examples.

### Input
* (IOObject) - This is an example set input port

### Output
* (Data Table) - This is an example set output port
* (Data Table) - The input without any modifications.

### Parameters
* attributes - Defines the attributes which should be used for the sorting.
```

--------------------------------

### Install Extension using Gradle

Source: https://docs.rapidminer.com/latest/developers/extensions/create/your-own-operator/configurations.html

Command to build and install the extension project. This command should be executed from the extension's root directory in the command prompt.

```bash
./gradlew installExtension

```

--------------------------------

### Iterate over examples

Source: https://docs.rapidminer.com/latest/studio/operators/utility/scripting/execute_script.html

Use a standard for-each loop to process every example in an ExampleSet.

```Groovy
for (Example example : exampleSet) { ... }
```

--------------------------------

### Install Altair RapidMiner Library

Source: https://docs.rapidminer.com/latest/python/library/index.html

Use pip to install the library in your Python environment.

```bash
pip install rapidminer
```

--------------------------------

### View sample data file structure

Source: https://docs.rapidminer.com/latest/developers/extensions/sample-repositories.html

Example of the file structure within the myextension_samples resource folder.

```text
 …
 └── myextension_samples
     ├── Subfolder
     │   ├── Custom data 2.ioo
     │   ├── Custom data 2.md
     │   └── Custom data 2.properties
     ├── Custom data.ioo
     ├── Custom data.md
     ├── Custom data.properties
     └── Subfolder.properties
```

--------------------------------

### Install altair-aitools-devkit

Source: https://docs.rapidminer.com/latest/developers/python-sdk/getting-started.html

Create and activate a conda environment, then install the required development package.

```bash
conda create -n sample-environment python=3.12
conda activate sample-environment
conda install altair-aitools-devkit -c conda-forge
```

--------------------------------

### Retrieve example values

Source: https://docs.rapidminer.com/latest/studio/operators/utility/scripting/execute_script.html

Access attribute values from an example using the attribute name as a key.

```Groovy
String value = example["attribute_name"];
double value = example["attribute_name"];
```

--------------------------------

### Tutorial: Store to and Retrieve from File

Source: https://docs.rapidminer.com/latest/studio/operators/data_access/external_store.html

An example process demonstrating the use of the 'Store to File' operator to convert a model into a file, write it to disk, and then retrieve it.

```APIDOC
## Tutorial: Store to and Retrieve from File

### Description
In this Example Process we create a model and convert it into a file using the _Store to File_ operator. The file is then written to disk using the _Write File_ operator. Instead of the _Write File_ operator another Write operator for an external storage like Write Dropbox, Write Google Drive, ... could be used. Then comes the part that would be usually done in another process: A new file object is created via the _Open File_ operator and then fed into the _Retrieve from File_ operator. Again, instead of the _Open File_ operator a Read operator like Read Dropbox, Read Google Drive, ... could be used. When you run the process you see the retrieved model in the Results view.
```

--------------------------------

### Set example values

Source: https://docs.rapidminer.com/latest/studio/operators/utility/scripting/execute_script.html

Modify attribute values within an example using the attribute name as a key.

```Groovy
example["attribute_name"] = "value";
example["attribute_name"] = 5.7;
```

--------------------------------

### Sample Disk Layout Configuration

Source: https://docs.rapidminer.com/latest/hub/install/kubernetes/air-gap.html

Example layout for cluster-on-local-pvc.yaml showing worker node disk mappings.

```text
worker1 10.15.131.218
        nvme0n1     259:0    0   80G  0 disk 
        └─nvme0n1p1 259:2    0   80G  0 part /
local1-0    nvme1n1     259:1    0   10G  0 disk 
local1-1    nvme2n1     259:3    0  256G  0 disk 

worker2 10.15.187.25
        nvme0n1     259:0    0   80G  0 disk 
        └─nvme0n1p1 259:1    0   80G  0 part /
local2-0    nvme1n1     259:2    0   10G  0 disk 
local2-1    nvme2n1     259:3    0  256G  0 disk 

worker3 10.15.164.202
        nvme0n1     259:0    0   80G  0 disk 
        └─nvme0n1p1 259:2    0   80G  0 part /
local3-0    nvme1n1     259:1    0   10G  0 disk 
local3-1    nvme2n1     259:3    0  256G  0 disk 
```

--------------------------------

### Internationalization Key Example

Source: https://docs.rapidminer.com/latest/developers/extensions/advanced-enhancements/custom-connection-type

Example of a fully qualified i18n key for a connection parameter, used for translation.

```string
gui.label.connection.parameter.shared_data.shared-data.basic.option

```
Tokens:
Raw