Collaborate via Projects
The concept of a Project was introduced in RapidMiner 9.7.
A Project is a shared repository with version control provided by Git.
Projects enable your team to collaborate easily and safely, because you can roll back your changes at any point in time. Under the hood, the Projects of RapidMiner AI Hub utilize a Git Server, enabling the connection to third-party tools, but no knowledge of Git is required when working with Projects.
The following sections outline how to use and manage Projects.
- Create a new Project (or migrate an old one)
- Connect to a Project
- View a Project
- Edit a Project (permissions)
- Delete a Project
- Advanced Project usage and configuration
Create a Project
Create a Project within the RapidMiner AI Hub Web UI:
On the left, in the Repository menu, click on Projects:
The Projects page is displayed. On the top right, click Create Project.
The Create Project dialog opens.
- Enter a Project name.
- Enter a Project description.
- Grant permission to the users and groups who are allowed to connect to this Project.
- Click Create.
If you are creating a completely new Project, you should leave Initialize Project and Enable Git LFS checked. Enabling Git LFS reduces the impact of large files in your Project. By default, .ioo, .rmhdf5table, .collection and .conninfo file types are tracked with LFS.
If, on the other hand, you want to share an externally-created Git repository as a Project via RapidMiner AI Hub, you should:
- leave Initialize Project unchecked, and Create the Project
insert the Project URL as the remote URL in the external
.git/config, and execute
[remote "origin"] url = http://localhost:8080/executions/git/my-project.git
if Git LFS is enabled, the use of LFS in the client is highly recommended. Install LFS with
git lfs installand configure the LFS URL by running
git config lfs.url <your_server_address:port>/executions/lfs/my-project.git. Ensure that the .gitattributes file is tracked. By default, a
.lfsconfigis created during Project creation to ease this process for non RapidMiner clients.
Congratulations! You have created your first Project and it will be visible on the Projects page:
Connect to a Project
After you have created your first Project you can connect to it via RapidMiner Studio by
using the associated
In the same way, any external Git client can connect to the Project. For example, using the Git command-line interface, you can connect to the Project as follows:
git clone <Project URL>
If you need Bearer authentication to work with your CLI git clone, then you need to retrieve a valid JWT (
idToken) before invoking
the clone command from the REST API. Once you retrieved it, you can change the initial clone command to:
git -c http.extraHeader="Authorization: Bearer $idToken" clone <Project URL>
If you need to debug CLI git calls, add any of the common git debug environment variables before your git command.
View a Project
From the Projects page, you can browse individual Projects by clicking the View link next to the Project name.
The Overview page displays the meta information of the Project. Depending on your privileges, you can edit the permissions or delete the entire Project.
The Contents page allows you to browse the Project content on RapidMiner AI Hub.
- A click on a folder will display its content.
- A click on a file will open the details view for the specific file type.
The Snapshot History page displays the history of the Project. Each row in the table corresponds to a Snapshot.
To inspect a Snapshot, click on the three dots for that row and on View Snapshot. The details page lists the files and folders that have been changed in this Snapshot. You can download the whole Snapshot as a ZIP file by clicking Download Snapshot.
Edit a Project (permissions)
The permissions system distinguishes between content permissions and Project permissions.
Permitted Users & Groups have access to the contents of the Project. To add a user or group, select them from All Users & Groups, and press the right arrow.
- They can browse the Contents tab.
- They can modify the content via RapidMiner Studio or an external Git client.
- They cannot alter Project-related settings in the Overview tab.
Owners can change the Project-related settings in the Overview tab. To add an owner, use the search box below the list of existing owners.
- They can modify the lists of Permitted Users & Groups and Owners.
- They can delete the Project.
Delete a Project
CAUTION: The delete operation is a destructive operation and CANNOT be undone. Deleted Projects are NOT recoverable!
Only the owners of a Project can delete a Project. To delete a Project, click Delete from within the Projects page or the Overview page.
To protect the Project, a confirmation dialog is displayed. To confirm that you really want to delete the Project, you must first enter the Project name, and then click Delete.
Advanced Project usage and configuration
Caching Projects in Job Containers
Job Containers cache Projects and update them before every execution, to reduce download times. To control cache sizes in Job Containers, see the configuration options described under Container caching for Projects.
Git server configuration
By default, Project data resides within the RapidMiner Server/AI Hub home directory, under
You can configure Project behavior by modifying the Git configuration files inside this directory.
Force-push and deletions
In new Projects, force pushes and deletions are disabled. This behavior can be changed for any Project at any time by manually editing the file
and changing the attribute values in the
[receive] section from
[receive] denyNonFastForwards = false denyDeletes = false
If you like to disable automatic sample Project creation on startup, add the property
repositories.sample.enabled with value
false to the
execution.properties file within the
<rapidminer-home>/configuration folder of your RapidMiner Server/AI Hub home directory.
By default, files with a leading dot, such as
.gitattributes, are automatically hidden in the Project content browser. You can view these hidden files using the toggle button in the Project content browser.
In the contents browser and the Project creation dialog and in the Project content browser, you can upload a .zip file, so the project will be populated with its contents. The maximum file size limit of those .zip file is 5 GB. To increase it,
If you like to change the file size limit, add the property
repositories.maxUploadSize with a specific value like
10240Mb to set it to 10 GB in the
execution.properties file within the
<rapidminer-home>/configuration folder of
your RapidMiner Server/AI Hub home directory.