Skip to content

Latest commit

 

History

History
96 lines (56 loc) · 2.59 KB

Server.md

File metadata and controls

96 lines (56 loc) · 2.59 KB
Raw

rapidminer

Server

Server(self, logger=None, loglevel=logging.INFO)

Class for using a local or remote RapidMiner Server instance directly. You can execute processes using the scalable Job Agent architecture.

Server(url=None,
            authentication_server=None,
            client_secret=None,
            offline_token=None,
            verifySSL=True,
            logger=None,
            loglevel=logging.INFO)

Initializes a new connector to a local or remote Rapidminer Server instance.

Arguments:

  • url: Server url path (hostname and port as well)
  • authentication_server: Authentication Server url (together with the port).
  • client_secret: Client secret for OAuth authentication via a non-public keycloak client
  • offline_token: Offline token for authentication acquired via the /get-token endpoint
  • verifySSL: Either a boolean to control whether the server's TLS certificate is verified, or a string as a path to a CA bundle. Default is True.
  • logger: A Logger object to use. By default, a simple logger with INFO level logging to stdout is used.
  • loglevel: the loglevel, as an int value. Common values are defined in the standard logging module. Only used, if logger is not defined.

run_process

Server.run_process(path, project=None, macros={}, queue='DEFAULT')

Runs a RapidMiner process.

Arguments:

  • path: path to the RapidMiner process in the Project. It can be a string or a rapidminer.ProjectLocation object.
  • project: optional project name. If the path parameter is a rapidminer.ProjectLocation, then it is not needed to be defined.
  • macros: optional dict that sets the macros in the process context according to the key-value pairs, e.g. macros={"macro1": "value1", "macro2": "value2"}
  • queue: the name of the queue to submit the process to. Default is DEFAULT.

get_queues

Server.get_queues()

Gets information of the available queues in the Server instance.

Returns:

  • a JSON array of objects representing each queue with its properties

get_projects

Server.get_projects()

Gets information of the available projects in the AI Hub instance.

Returns:

  • a JSON array of objects representing each repository with its properties

get_connections

Server.get_connections(project)

Read the connections from the AI Hub repository.

Returns:

  • Connections object listing connections from the AI Hub repository. Note that values of encrypted fields are not available (values will be None). Use AI Hub Vault to securely store and retrieve these values instead