Skip to content
This repository was archived by the owner on Mar 29, 2023. It is now read-only.

Commit 6812cdf

Browse files
JanKalkanactions-user
authored andcommitted
Apply automatic release changes for v0.2.3
1 parent 0e69cca commit 6812cdf

14 files changed

+262
-254
lines changed

Pipfile.lock

Lines changed: 112 additions & 104 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/lazycluster.cluster.dask_cluster.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- markdownlint-disable -->
22

3-
<a href="../src/lazycluster/cluster/dask_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/dask_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.dask_cluster`
66
Module for conveniently managing a [DASK](http://distributed.dask.org) cluster.
@@ -9,7 +9,7 @@ Module for conveniently managing a [DASK](http://distributed.dask.org) cluster.
99

1010
---
1111

12-
<a href="../src/lazycluster/cluster/dask_cluster.py#L15"><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/dask_cluster.py#L15"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
1313

1414
## <kbd>class</kbd> `LocalMasterLauncher`
1515
Concrete implementation of the `MasterLauncher` interface. See its documentation to get a list of the inherited methods and attributes.
@@ -45,7 +45,7 @@ The process object where the master instance was started in.
4545

4646
---
4747

48-
<a href="../src/lazycluster/cluster/dask_cluster.py#L92"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
48+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L92"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
4949

5050
### <kbd>method</kbd> `cleanup`
5151

@@ -57,7 +57,7 @@ Release all resources.
5757

5858
---
5959

60-
<a href="../src/lazycluster/cluster/dask_cluster.py#L21"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
60+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L21"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
6161

6262
### <kbd>method</kbd> `start`
6363

@@ -101,12 +101,12 @@ Launch a master instance.
101101

102102
---
103103

104-
<a href="../src/lazycluster/cluster/dask_cluster.py#L98"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
104+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L98"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
105105

106106
## <kbd>class</kbd> `RoundRobinLauncher`
107107
WorkerLauncher implementation for launching DASK workers in a round robin manner. See its documentation to get a list of the inherited methods and attributes.
108108

109-
<a href="../src/lazycluster/cluster/dask_cluster.py#L101"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
109+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L101"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
110110

111111
### <kbd>method</kbd> `__init__`
112112

@@ -139,7 +139,7 @@ Dictionary with the host as key and a port list as value. The list contains all
139139

140140
---
141141

142-
<a href="../src/lazycluster/cluster/dask_cluster.py#L211"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
142+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L211"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
143143

144144
### <kbd>method</kbd> `cleanup`
145145

@@ -151,7 +151,7 @@ Release all resources.
151151

152152
---
153153

154-
<a href="../src/lazycluster/cluster/dask_cluster.py#L112"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
154+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L112"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
155155

156156
### <kbd>method</kbd> `start`
157157

@@ -190,7 +190,7 @@ Launches the worker instances in the `RuntimeGroup`.
190190

191191
---
192192

193-
<a href="../src/lazycluster/cluster/dask_cluster.py#L217"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
193+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L217"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
194194

195195
## <kbd>class</kbd> `DaskCluster`
196196
Convenient class for launching a Dask cluster in a `RuntimeGroup`.
@@ -199,7 +199,7 @@ DaskCluster inherits from MasterWorkerCluster. See its documentation to get a li
199199

200200
The number of DASK 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 DASK 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 DASK master (i.e. scheduler) 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`.
201201

202-
<a href="../src/lazycluster/cluster/dask_cluster.py#L235"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
202+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L235"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
203203

204204
### <kbd>method</kbd> `__init__`
205205

@@ -252,7 +252,7 @@ The RuntimeGroup.
252252

253253
---
254254

255-
<a href="../src/lazycluster/cluster/dask_cluster.py#L279"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
255+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L279"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
256256

257257
### <kbd>method</kbd> `cleanup`
258258

@@ -264,7 +264,7 @@ Release all resources.
264264

265265
---
266266

267-
<a href="../src/lazycluster/cluster/dask_cluster.py#L266"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
267+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/dask_cluster.py#L266"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
268268

269269
### <kbd>method</kbd> `get_client`
270270

docs/lazycluster.cluster.exceptions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- markdownlint-disable -->
22

3-
<a href="../src/lazycluster/cluster/exceptions.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/exceptions.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.exceptions`
66
Exception module for cluster classes.
@@ -15,12 +15,12 @@ Exception module for cluster classes.
1515

1616
---
1717

18-
<a href="../src/lazycluster/cluster/exceptions.py#L11"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
18+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/exceptions.py#L11"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
1919

2020
## <kbd>class</kbd> `MasterStartError`
2121
Error indicating that the cluster master instance could not be started successfully.
2222

23-
<a href="../src/lazycluster/cluster/exceptions.py#L14"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
23+
<a href="https://github.com/ml-tooling/lazycluster/blob/main/src/lazycluster/cluster/exceptions.py#L14"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
2424

2525
### <kbd>method</kbd> `__init__`
2626

docs/lazycluster.cluster.hyperopt_cluster.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
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`
66
Module 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`
1515
Abstract implementation of the `MasterLauncher` interface used to implement a concrete launch strategy for mongodb instance used in hyperopt.
1616

1717
This 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`
6868
Concrete implementation of the `MasterLauncher` interface. See its documentation to get a list of the inherited methods and attributes.
6969

7070
This 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`
212212
Concrete WorkerLauncher implementation for launching hyperopt workers in a round robin manner.
213213

214214
See 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`
302302
Convenient class for launching a Hyperopt cluster in a `RuntimeGroup`.
@@ -305,7 +305,7 @@ HyperoptCluster inherits from MasterWorkerCluster. See its documentation to get
305305

306306
The 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

docs/lazycluster.cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<!-- markdownlint-disable -->
22

3-
<a href="../src/lazycluster/cluster/__init__.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/__init__.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`
66

0 commit comments

Comments
 (0)