README.md

API Overview

Modules

• lazycluster.cluster
• lazycluster.cluster.dask_cluster: Module for conveniently managing a DASK cluster.
• lazycluster.cluster.exceptions: Exception module for cluster classes.
• lazycluster.cluster.hyperopt_cluster: Module for conveniently managing a Hyperopt cluster.
• lazycluster.cluster.runtime_cluster: Module comprising the abstract RuntimeCluster class with its related launcher strategy classes.
• lazycluster.exceptions: Exception module.
• lazycluster.runtime_mgmt: Runtime management module. This module contains convenient classes for working with Runtimes and RuntimeTasks.
• lazycluster.runtimes: Runtimes module.
• lazycluster.scripts
• lazycluster.scripts.cli_handler
• lazycluster.settings: Contains setting parameters for the library.
• lazycluster.utils

Classes

• dask_cluster.DaskCluster: Convenient class for launching a Dask cluster in a RuntimeGroup.
• dask_cluster.LocalMasterLauncher: Concrete implementation of the MasterLauncher interface. See its documentation to get a list of the inherited methods and attributes.
• dask_cluster.RoundRobinLauncher: WorkerLauncher implementation for launching DASK workers in a round robin manner. See its documentation to get a list of the inherited methods and attributes.
• exceptions.MasterStartError: Error indicating that the cluster master instance could not be started successfully.
• hyperopt_cluster.HyperoptCluster: Convenient class for launching a Hyperopt cluster in a RuntimeGroup.
• hyperopt_cluster.LocalMongoLauncher: Concrete implementation of the MasterLauncher interface. See its documentation to get a list of the inherited methods and attributes.
• hyperopt_cluster.MongoLauncher: Abstract implementation of the MasterLauncher interface used to implement a concrete launch strategy for mongodb instance used in hyperopt.
• hyperopt_cluster.RoundRobinLauncher: Concrete WorkerLauncher implementation for launching hyperopt workers in a round robin manner.
• runtime_cluster.MasterLauncher: Abstract class for implementing the strategy for launching the master instance of the cluster.
• runtime_cluster.MasterWorkerCluster: Class for clusters following a master-worker architecture.
• runtime_cluster.RuntimeCluster: Abstract cluster class.
• runtime_cluster.WorkerLauncher: Abstract class for implementing the strategy for launching worker instances within a RuntimeGroup.
• exceptions.InvalidRuntimeError: Error indicating that a Runtime can not be instantiated properly.
• exceptions.LazyclusterError: Basic exception class for lazycluster library errors.
• exceptions.NoPortsLeftError: Error indicating that there are no more ports left from the given port list.
• exceptions.NoRuntimesDetectedError: Error indicating that no Runtime could be detcted automatically by a RuntimeManager for example.
• exceptions.PathCreationError: Error indicating that a given path could not be created.
• exceptions.PortInUseError: Error indicating that a port is already in use in a RuntimeGroup or on the local machine.
• exceptions.TaskExecutionError: This error relates to exceptions occured during RuntimeTask execution.
• runtime_mgmt.RuntimeGroup: A RuntimeGroup is the representation of logically related Runtimes.
• runtime_mgmt.RuntimeManager: The RuntimeManager can be used for a simplified resource management.
• runtimes.Runtime: A Runtime is the logical representation of a remote host.
• runtimes.RuntimeTask: This class provides the functionality for executing a sequence of elementary operations over ssh.
• utils.Environment: This class contains environment variables.
• utils.ExecutionFileLogUtil: Generic class used to write log files.
• utils.Timestamp: Custom Timestamp class with convenient methods.

Functions

• No functions

---

This file was automatically generated via lazydocs.