dlboard 0.1.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. dlboard-0.1.3/.gitignore +21 -0
  2. dlboard-0.1.3/LICENSE +201 -0
  3. dlboard-0.1.3/PKG-INFO +60 -0
  4. dlboard-0.1.3/README.md +18 -0
  5. dlboard-0.1.3/dlboard/__init__.py +1 -0
  6. dlboard-0.1.3/dlboard/_batching.py +153 -0
  7. dlboard-0.1.3/dlboard/_compat.py +31 -0
  8. dlboard-0.1.3/dlboard/_identity.py +48 -0
  9. dlboard-0.1.3/dlboard/_mp_context.py +15 -0
  10. dlboard-0.1.3/dlboard/_version.py +17 -0
  11. dlboard-0.1.3/dlboard/_wire.py +111 -0
  12. dlboard-0.1.3/dlboard/client/__init__.py +10 -0
  13. dlboard-0.1.3/dlboard/client/_rest_api.py +293 -0
  14. dlboard-0.1.3/dlboard/client/artifacts/__init__.py +1 -0
  15. dlboard-0.1.3/dlboard/client/artifacts/image.py +76 -0
  16. dlboard-0.1.3/dlboard/client/artifacts/link.py +43 -0
  17. dlboard-0.1.3/dlboard/client/dlboard_logger.py +437 -0
  18. dlboard-0.1.3/dlboard/models/__init__.py +114 -0
  19. dlboard-0.1.3/dlboard/models/_access.py +68 -0
  20. dlboard-0.1.3/dlboard/models/_activity.py +20 -0
  21. dlboard-0.1.3/dlboard/models/_artifact.py +113 -0
  22. dlboard-0.1.3/dlboard/models/_artifact_purge_task.py +43 -0
  23. dlboard-0.1.3/dlboard/models/_audit_log.py +66 -0
  24. dlboard-0.1.3/dlboard/models/_auth.py +69 -0
  25. dlboard-0.1.3/dlboard/models/_comment.py +30 -0
  26. dlboard-0.1.3/dlboard/models/_credentials.py +53 -0
  27. dlboard-0.1.3/dlboard/models/_data_store.py +418 -0
  28. dlboard-0.1.3/dlboard/models/_experiment.py +75 -0
  29. dlboard-0.1.3/dlboard/models/_hparams.py +56 -0
  30. dlboard-0.1.3/dlboard/models/_metric.py +74 -0
  31. dlboard-0.1.3/dlboard/models/_plugin.py +46 -0
  32. dlboard-0.1.3/dlboard/models/_project.py +47 -0
  33. dlboard-0.1.3/dlboard/models/_run.py +43 -0
  34. dlboard-0.1.3/dlboard/models/_scopes.py +43 -0
  35. dlboard-0.1.3/dlboard/models/_theme.py +57 -0
  36. dlboard-0.1.3/dlboard/models/_user.py +103 -0
  37. dlboard-0.1.3/dlboard/models/_view.py +483 -0
  38. dlboard-0.1.3/dlboard/py.typed +0 -0
  39. dlboard-0.1.3/hatch_build.py +53 -0
  40. dlboard-0.1.3/pyproject.toml +99 -0
@@ -0,0 +1,21 @@
1
+ # Python-generated files
2
+ __pycache__/
3
+ *.py[oc]
4
+ build/
5
+ dist/
6
+ wheels/
7
+ *.egg-info
8
+
9
+ # Virtual environments
10
+ .venv
11
+ *.env
12
+ .data/
13
+ lightning-logs/
14
+ _scratch_test.py
15
+ .coverage
16
+
17
+ # Output of the docs-screenshot check (see dlboard/tests/docs_screenshots_test.py)
18
+ screenshot-diffs/
19
+
20
+ # Claude Code's own local settings/session state -- developer-machine-local, not project config.
21
+ .claude/
dlboard-0.1.3/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 David Langerman
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
dlboard-0.1.3/PKG-INFO ADDED
@@ -0,0 +1,60 @@
1
+ Metadata-Version: 2.5
2
+ Name: dlboard
3
+ Version: 0.1.3
4
+ Summary: A pytorch_lightning-compatible logger client for dlboard, a free, self-hosted experiment-tracking server.
5
+ Project-URL: Changelog, https://github.com/dlangerm/dlboard/blob/main/CHANGELOG.md
6
+ Project-URL: Documentation, https://github.com/dlangerm/dlboard#readme
7
+ Project-URL: Homepage, https://github.com/dlangerm/dlboard
8
+ Project-URL: Issues, https://github.com/dlangerm/dlboard/issues
9
+ Project-URL: Repository, https://github.com/dlangerm/dlboard
10
+ Author-email: David Langerman <dev.onyxzerosoftware@gmail.com>
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Keywords: experiment-tracking,logging,machine-learning,mlops,pytorch-lightning
14
+ Classifier: Development Status :: 4 - Beta
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Intended Audience :: Science/Research
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
24
+ Classifier: Topic :: Software Development :: Libraries :: Python Modules
25
+ Classifier: Typing :: Typed
26
+ Requires-Python: >=3.10
27
+ Requires-Dist: coolname>=5.0.0
28
+ Requires-Dist: dltype>=0.16.0
29
+ Requires-Dist: numpy>=2.2.0
30
+ Requires-Dist: pendulum>=3.2.0
31
+ Requires-Dist: pillow>=12.3.0
32
+ Requires-Dist: pydantic-settings>=2.14.2
33
+ Requires-Dist: pydantic>=2.13.4
34
+ Requires-Dist: requests>=2.32.0
35
+ Requires-Dist: structlog>=26.1.0
36
+ Requires-Dist: typing-extensions>=4.12.0
37
+ Provides-Extra: lightning
38
+ Requires-Dist: pytorch-lightning>=2.6.5; extra == 'lightning'
39
+ Provides-Extra: server
40
+ Requires-Dist: dlboard-server; extra == 'server'
41
+ Description-Content-Type: text/markdown
42
+
43
+ # dlboard
44
+
45
+ A `pytorch_lightning`-compatible logger client for [dlboard](https://github.com/dlangerm/dlboard), a
46
+ free, self-hosted ML experiment-tracking server. This package ships metrics, hyperparameters, and
47
+ artifacts from a training script to a running dlboard server over a REST API.
48
+
49
+ ```python
50
+ from dlboard.client.dlboard_logger import DLBoardLogger
51
+
52
+ logger = DLBoardLogger.from_names("my-project", "my-experiment", "a description")
53
+ trainer = pl.Trainer(logger=logger)
54
+ ```
55
+
56
+ You'll also need a dlboard server to point it at — either `pip install dlboard[server]` for a
57
+ single-machine setup, or a shared deployment your team already runs. See the
58
+ [project README](https://github.com/dlangerm/dlboard#readme) for the full picture, and
59
+ [docs/client.md](https://github.com/dlangerm/dlboard/blob/main/docs/client.md) for logger setup,
60
+ authentication, and logging custom artifact types.
@@ -0,0 +1,18 @@
1
+ # dlboard
2
+
3
+ A `pytorch_lightning`-compatible logger client for [dlboard](https://github.com/dlangerm/dlboard), a
4
+ free, self-hosted ML experiment-tracking server. This package ships metrics, hyperparameters, and
5
+ artifacts from a training script to a running dlboard server over a REST API.
6
+
7
+ ```python
8
+ from dlboard.client.dlboard_logger import DLBoardLogger
9
+
10
+ logger = DLBoardLogger.from_names("my-project", "my-experiment", "a description")
11
+ trainer = pl.Trainer(logger=logger)
12
+ ```
13
+
14
+ You'll also need a dlboard server to point it at — either `pip install dlboard[server]` for a
15
+ single-machine setup, or a shared deployment your team already runs. See the
16
+ [project README](https://github.com/dlangerm/dlboard#readme) for the full picture, and
17
+ [docs/client.md](https://github.com/dlangerm/dlboard/blob/main/docs/client.md) for logger setup,
18
+ authentication, and logging custom artifact types.
@@ -0,0 +1 @@
1
+ """DLBoard main entrypoint."""
@@ -0,0 +1,153 @@
1
+ """
2
+ Drain a queue into batches and ship each one somewhere that can fail.
3
+
4
+ Shared by the client's metric/artifact shipping processes (`dlboard_logger.py`) and every blob
5
+ artifact store's ref-ingest thread (`plugins/data_stores/_blob_store.py`) -- both batch items off a
6
+ queue towards a destination that can fail transiently (a server, a locked database), and both must
7
+ never lose a batch to a failure that a retry would have survived.
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ import logging
13
+ import random
14
+ import time
15
+ from queue import Empty
16
+ from typing import TYPE_CHECKING, NamedTuple, Protocol, TypeVar
17
+
18
+ if TYPE_CHECKING:
19
+ from collections.abc import Callable
20
+ from multiprocessing.synchronize import Event as MPEvent
21
+
22
+ _log = logging.getLogger(__name__)
23
+
24
+ T = TypeVar("T")
25
+ """Pre-3.12 `TypeVar` style (the client's floor is 3.10): the kind of item `ship_batches` moves."""
26
+
27
+ _T_co = TypeVar("_T_co", covariant=True)
28
+ """`Receiver`'s own type parameter -- covariant, since it only ever appears in a return position."""
29
+
30
+ _MAX_BACKOFF_FACTOR: int = 6
31
+ """Caps retry backoff at `wait_sec * 2**6` (64x) -- a dead server shouldn't make the next retry wait
32
+ arbitrarily long, just long enough to stop hammering it."""
33
+
34
+ _JITTER_FRACTION: float = 0.25
35
+ """+/- this fraction of the computed backoff, so many shipping processes retrying the same outage
36
+ don't all land on the server in lockstep."""
37
+
38
+
39
+ class BatchParams(NamedTuple):
40
+ """How `ship_batches` batches, plus the events it reports through."""
41
+
42
+ flush_size: int
43
+ wait_sec: float
44
+ ready: MPEvent
45
+ flushed: MPEvent
46
+
47
+
48
+ class Receiver(Protocol[_T_co]):
49
+ """The one queue method `ship_batches` needs -- both `multiprocessing` and `queue` queues have it."""
50
+
51
+ def get(self, block: bool = True, timeout: float | None = None) -> _T_co: ... # noqa: FBT001, FBT002
52
+
53
+
54
+ def _split_oversized(
55
+ ship: Callable[[list[T]], None],
56
+ batch: list[T],
57
+ *,
58
+ is_permanent: Callable[[Exception], bool],
59
+ is_oversized: Callable[[Exception], bool],
60
+ ) -> list[T]:
61
+ """
62
+ Ship `batch` in two halves, recursing into a half that's still too large, down to one item each.
63
+
64
+ Returns whatever's left unshipped: a permanently-rejected chunk is dropped (and so absent from
65
+ the result), but one that fails for some other transient reason comes back in it, for
66
+ `ship_batches` to retry (at its own pace, with backoff) on a later pass -- never lost, and never
67
+ re-sent on top of a chunk that already landed. A chunk of exactly one item that's still too
68
+ large has nothing left to split into, so it's treated as permanent either way: resending the
69
+ same single oversized item can never succeed.
70
+ """
71
+ mid = len(batch) // 2
72
+ leftover: list[T] = []
73
+ for chunk in (batch[:mid], batch[mid:]):
74
+ try:
75
+ ship(chunk)
76
+ except Exception as exc: # noqa: BLE001 -- nothing may kill the shipping loop
77
+ if is_oversized(exc) and len(chunk) > 1:
78
+ leftover.extend(
79
+ _split_oversized(ship, chunk, is_permanent=is_permanent, is_oversized=is_oversized)
80
+ )
81
+ elif is_permanent(exc):
82
+ _log.exception("A sub-batch of %s was rejected, dropping it", len(chunk))
83
+ else:
84
+ leftover.extend(chunk) # transient; retry (with backoff) on a later pass
85
+ return leftover
86
+
87
+
88
+ def ship_batches(
89
+ q: Receiver[T | None],
90
+ ship: Callable[[list[T]], None],
91
+ params: BatchParams,
92
+ *,
93
+ is_permanent: Callable[[Exception], bool],
94
+ is_oversized: Callable[[Exception], bool] = lambda _exc: False,
95
+ ) -> None:
96
+ """
97
+ Forever drain `q` into batches, shipping one once it's full, `wait_sec` old, or a flush asks for it.
98
+
99
+ A batch whose failure `is_permanent` is dropped: resending it can never succeed, and keeping it
100
+ would wedge every later item behind it. A batch whose failure `is_oversized` is instead split in
101
+ half and each half attempted once right away (`_split_oversized`) -- resending the exact same
102
+ oversized batch could never succeed either, but a batch that only grew this large because the
103
+ server was briefly unreachable shouldn't be dropped just because it doesn't fit in one request
104
+ once it's reachable again. Any other failure is transient -- the batch is kept, keeps growing
105
+ with whatever arrives meanwhile, and is retried after an exponentially growing backoff (reset
106
+ the moment a batch ships successfully) rather than hammering a server that's still down. A
107
+ `None` queued in place of an item requests a flush, acknowledged (`params.flushed`) only once
108
+ everything queued before it is gone. Returns once `q` itself is closed (e.g. at interpreter
109
+ shutdown) -- nothing more can ever arrive through it.
110
+ """
111
+ params.ready.set()
112
+ batch: list[T] = []
113
+ flush_requested = False
114
+ last_attempt = time.perf_counter()
115
+ consecutive_failures = 0
116
+ while True:
117
+ try:
118
+ item = q.get(timeout=params.wait_sec / 10)
119
+ if item is None:
120
+ flush_requested = True
121
+ else:
122
+ batch.append(item)
123
+ except Empty:
124
+ pass
125
+ except (OSError, ValueError): # a closed `multiprocessing` queue raises one or the other
126
+ return
127
+ due = flush_requested or len(batch) >= params.flush_size
128
+ if batch and (due or time.perf_counter() - last_attempt > params.wait_sec):
129
+ try:
130
+ ship(batch)
131
+ batch = []
132
+ consecutive_failures = 0
133
+ except Exception as exc: # noqa: BLE001 -- nothing may kill the shipping loop
134
+ if is_oversized(exc) and len(batch) > 1:
135
+ _log.warning("A batch of %s was too large for one request, splitting it", len(batch))
136
+ batch = _split_oversized(
137
+ ship, batch, is_permanent=is_permanent, is_oversized=is_oversized
138
+ )
139
+ consecutive_failures = 0
140
+ elif is_permanent(exc):
141
+ _log.exception("A batch of %s was rejected, dropping it", len(batch))
142
+ batch = []
143
+ consecutive_failures = 0
144
+ else:
145
+ _log.exception("Failed to ship a batch of %s, retrying", len(batch))
146
+ backoff = params.wait_sec * 2 ** min(consecutive_failures, _MAX_BACKOFF_FACTOR)
147
+ jitter = backoff * _JITTER_FRACTION
148
+ time.sleep(backoff + random.uniform(-jitter, jitter))
149
+ consecutive_failures += 1
150
+ last_attempt = time.perf_counter()
151
+ if flush_requested and not batch:
152
+ flush_requested = False
153
+ params.flushed.set()
@@ -0,0 +1,31 @@
1
+ """
2
+ Backports for stdlib `typing`/`enum` members not available on the client's floor (Python 3.10).
3
+
4
+ Nothing here is dlboard-specific; it exists only because the client supports 3.10+ while the
5
+ syntax/stdlib members below landed later. Every model/client module that needs one of these
6
+ imports it from here instead of `enum` directly, so there's exactly one place that cares which
7
+ Python version is actually running.
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ from typing import TYPE_CHECKING
13
+
14
+ if TYPE_CHECKING:
15
+ # Pyright always sees the real `enum.StrEnum` -- this repo's own dev/CI env always has 3.12+.
16
+ # The try/except below is the runtime-only fallback, for an actual 3.10/3.11 interpreter.
17
+ from enum import StrEnum
18
+ else:
19
+ try:
20
+ from enum import StrEnum
21
+ except ImportError: # Python < 3.11 (PEP 663 landed in 3.11)
22
+ from enum import Enum
23
+
24
+ class StrEnum(str, Enum):
25
+ """A `str`-valued `Enum` whose `str()` is its value, not `ClassName.MEMBER`."""
26
+
27
+ def __str__(self) -> str:
28
+ return str(self.value)
29
+
30
+
31
+ __all__ = ["StrEnum"]
@@ -0,0 +1,48 @@
1
+ """
2
+ Best-effort resolution of "who is running this" for attribution purposes.
3
+
4
+ This is an identity helper, not authentication -- nothing here is a security boundary, and nothing
5
+ here proves a caller actually is who they claim. It exists so a local, single-user dlboard install
6
+ can attribute projects/experiments/runs to *someone* with zero configuration, the same way `git`
7
+ picks up `user.name` from the environment. Used by both the client (`dlboard.client`, to label
8
+ what it logs) and the server (schema migrations, to pick a name for the one-time bootstrap admin).
9
+ """
10
+
11
+ from __future__ import annotations
12
+
13
+ import getpass
14
+
15
+ from pydantic_settings import BaseSettings
16
+ from structlog.stdlib import get_logger
17
+
18
+ _log = get_logger(__name__)
19
+
20
+ ANONYMOUS: str = "anonymous"
21
+
22
+
23
+ class _IdentitySettings(BaseSettings):
24
+ """Reads the `DLBOARD_USER` env var `resolve_username` checks first."""
25
+
26
+ dlboard_user: str = ""
27
+
28
+
29
+ def resolve_username() -> str:
30
+ """
31
+ Resolve a username via a best-effort chain: the `DLBOARD_USER` env var, then the OS login name, then `"anonymous"`.
32
+
33
+ Every step is wrapped so a failure (e.g. `getpass.getuser()` raising in a sandboxed container
34
+ with no passwd entry) falls through to the next step instead of raising.
35
+ """
36
+ env_value = _IdentitySettings().dlboard_user.strip()
37
+ if env_value:
38
+ return env_value
39
+
40
+ try:
41
+ os_username = getpass.getuser().strip()
42
+ except Exception: # noqa: BLE001
43
+ _log.debug("Could not resolve an OS username, falling back to %s", ANONYMOUS)
44
+ else:
45
+ if os_username:
46
+ return os_username
47
+
48
+ return ANONYMOUS
@@ -0,0 +1,15 @@
1
+ """
2
+ Shared multiprocessing context for dlboard's background worker processes.
3
+
4
+ `DLBoardLogger` (client-side metric/artifact shipping) and `BlobArtifactStore` (server-side blob
5
+ writes) each spawn a worker process off a `multiprocessing.Queue`; both need the same "spawn"
6
+ context (never "fork", which can deadlock a process that already has threads running -- both of
7
+ these do, e.g. Flask's/Dash's request-handling threads on the server side). Sharing one context
8
+ instance keeps that choice in exactly one place instead of two independent literal `"spawn"` calls.
9
+ """
10
+
11
+ from __future__ import annotations
12
+
13
+ from multiprocessing import get_context
14
+
15
+ SPAWN_CONTEXT = get_context("spawn")
@@ -0,0 +1,17 @@
1
+ """
2
+ The single source of dlboard's version.
3
+
4
+ Both `client/pyproject.toml` and `server/pyproject.toml` read `__version__` from here via hatch's
5
+ dynamic `[tool.hatch.version]` (see their own `path` setting), instead of each hardcoding its own
6
+ `version` field -- which is how the two distributions drifted out of lockstep before this existed:
7
+ nothing kept `dlboard`'s version and `dlboard-server`'s `dlboard==...` pin pointed at the same
8
+ release. Bump this one file to cut a release; neither `pyproject.toml`'s `version` is ever edited
9
+ directly.
10
+
11
+ Also read at runtime -- `Identity.server_version` (see `dlboard._wire`) is what a client's `whoami`
12
+ handshake actually sees.
13
+ """
14
+
15
+ # No type annotation -- hatchling's default `regex` version source (`[tool.hatch.version]` in both
16
+ # `pyproject.toml`s) matches `__version__ *= *"..."` literally and wouldn't see this past a `: str`.
17
+ __version__ = "0.1.3"