11<!-- markdownlint-disable -->
22
3- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L0" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
3+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L0" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
44
55# <kbd >module</kbd > ` lazycluster.cluster.hyperopt_cluster `
66Module for conveniently managing a [ Hyperopt] ( https://github.com/hyperopt/hyperopt ) cluster.
@@ -9,14 +9,14 @@ Module for conveniently managing a [Hyperopt](https://github.com/hyperopt/hypero
99
1010---
1111
12- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L14" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
12+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L14" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
1313
1414## <kbd >class</kbd > ` MongoLauncher `
1515Abstract implementation of the ` MasterLauncher ` interface used to implement a concrete launch strategy for mongodb instance used in hyperopt.
1616
1717This class implements the logic for starting a MongoDB instance on localhost. Hence, we simply treat the MongoDB instance as master node.
1818
19- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L21" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
19+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L21" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
2020
2121### <kbd >method</kbd > ` __init__ `
2222
@@ -62,14 +62,14 @@ The process object where the master instance was started in.
6262
6363---
6464
65- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L31" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
65+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L31" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
6666
6767## <kbd >class</kbd > ` LocalMongoLauncher `
6868Concrete implementation of the ` MasterLauncher ` interface. See its documentation to get a list of the inherited methods and attributes.
6969
7070This class implements the logic for starting a MongoDB instance on localhost. Hence, we simply treat the MongoDB instance as master node.
7171
72- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L21" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
72+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L21" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
7373
7474### <kbd >method</kbd > ` __init__ `
7575
@@ -114,7 +114,7 @@ The process object where the master instance was started in.
114114
115115---
116116
117- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L141" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
117+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L141" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
118118
119119### <kbd >method</kbd > ` cleanup `
120120
@@ -126,7 +126,7 @@ Release all resources.
126126
127127---
128128
129- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L122" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
129+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L122" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
130130
131131### <kbd >method</kbd > ` get_mongod_start_cmd `
132132
@@ -144,7 +144,7 @@ Get the shell command for starting mongod as a deamon process.
144144
145145---
146146
147- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L133" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
147+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L133" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
148148
149149### <kbd >method</kbd > ` get_mongod_stop_cmd `
150150
@@ -162,7 +162,7 @@ Get the shell command for stopping the currently running mongod process.
162162
163163---
164164
165- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L38" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
165+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L38" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
166166
167167### <kbd >method</kbd > ` start `
168168
@@ -206,14 +206,14 @@ Launch a master instance.
206206
207207---
208208
209- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L153" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
209+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L153" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
210210
211211## <kbd >class</kbd > ` RoundRobinLauncher `
212212Concrete WorkerLauncher implementation for launching hyperopt workers in a round robin manner.
213213
214214See the ` WorkerLauncher ` documentation to get a list of the inherited methods and attributes.
215215
216- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L159" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
216+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L159" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
217217
218218### <kbd >method</kbd > ` __init__ `
219219
@@ -251,7 +251,7 @@ Dictionary with the host as key and a port list as value. The list contains all
251251
252252---
253253
254- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L251" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
254+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L251" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
255255
256256### <kbd >method</kbd > ` cleanup `
257257
@@ -263,7 +263,7 @@ Release all resources.
263263
264264---
265265
266- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L183" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
266+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L183" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
267267
268268### <kbd >method</kbd > ` start `
269269
@@ -296,7 +296,7 @@ Launches the worker instances in the `RuntimeGroup`.
296296
297297---
298298
299- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L257" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
299+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L257" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
300300
301301## <kbd >class</kbd > ` HyperoptCluster `
302302Convenient class for launching a Hyperopt cluster in a ` RuntimeGroup ` .
@@ -305,7 +305,7 @@ HyperoptCluster inherits from MasterWorkerCluster. See its documentation to get
305305
306306The number of hyperopt workers defaults to the number of ` Runtimes ` in the used ` RuntimeGroup ` . This number can be adjusted so that more or less workers than available ` Runtimes ` can be used. Per default the desired number of workers is started in a round robin way as implemented in ` RoundRobinLauncher ` . Consequently, this leads to an equal distribution of hyperopt workers in the ` RuntimeGroup ` . You can provide a custom implementation inheriting from the ` WorkerLauncher ` class in order to execute a different strategy how workers should be started. The master instance (i.e. the mongoDB) will always be started on localhost as implemented in ` LocalMasterLauncher ` . This behavior can also be changed by providing a custom implementation inheriting from the ` MasterLauncher ` .
307307
308- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L276" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
308+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L276" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
309309
310310### <kbd >method</kbd > ` __init__ `
311311
@@ -408,7 +408,7 @@ The RuntimeGroup.
408408
409409---
410410
411- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L396" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
411+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L396" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
412412
413413### <kbd >method</kbd > ` cleanup `
414414
@@ -420,7 +420,7 @@ Release all resources.
420420
421421---
422422
423- <a href =" .. /src/lazycluster/cluster/hyperopt_cluster.py#L370" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
423+ <a href =" https://github.com/ml-tooling/lazycluster/blob/main /src/lazycluster/cluster/hyperopt_cluster.py#L370" ><img align =" right " style =" float :right ;" src =" https://img.shields.io/badge/-source-cccccc?style=flat-square " ></a >
424424
425425### <kbd >method</kbd > ` start_master `
426426
0 commit comments