ddpsrun 0.1.0__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.
- ddpsrun-0.1.0/LICENSE +202 -0
- ddpsrun-0.1.0/PKG-INFO +182 -0
- ddpsrun-0.1.0/README.md +147 -0
- ddpsrun-0.1.0/ddpsrun/__init__.py +7 -0
- ddpsrun-0.1.0/ddpsrun/browser_login.py +281 -0
- ddpsrun-0.1.0/ddpsrun/cli.py +827 -0
- ddpsrun-0.1.0/ddpsrun/client.py +200 -0
- ddpsrun-0.1.0/ddpsrun/config.py +162 -0
- ddpsrun-0.1.0/ddpsrun.egg-info/PKG-INFO +182 -0
- ddpsrun-0.1.0/ddpsrun.egg-info/SOURCES.txt +18 -0
- ddpsrun-0.1.0/ddpsrun.egg-info/dependency_links.txt +1 -0
- ddpsrun-0.1.0/ddpsrun.egg-info/entry_points.txt +2 -0
- ddpsrun-0.1.0/ddpsrun.egg-info/requires.txt +6 -0
- ddpsrun-0.1.0/ddpsrun.egg-info/top_level.txt +1 -0
- ddpsrun-0.1.0/pyproject.toml +85 -0
- ddpsrun-0.1.0/setup.cfg +4 -0
- ddpsrun-0.1.0/tests/test_browser_login.py +313 -0
- ddpsrun-0.1.0/tests/test_cli.py +588 -0
- ddpsrun-0.1.0/tests/test_client.py +145 -0
- ddpsrun-0.1.0/tests/test_config.py +89 -0
ddpsrun-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 DDPS Lab
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
ddpsrun-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ddpsrun
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Submit a GPU job and get results back. No kubectl, no cloud account.
|
|
5
|
+
Author: DDPS Lab
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/ddps-lab/pacsrun-gw
|
|
8
|
+
Project-URL: Repository, https://github.com/ddps-lab/pacsrun-gw
|
|
9
|
+
Project-URL: Issues, https://github.com/ddps-lab/pacsrun-gw/issues
|
|
10
|
+
Keywords: gpu,kubernetes,batch,jobs,machine-learning,cloud
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: Intended Audience :: Developers
|
|
15
|
+
Classifier: Operating System :: OS Independent
|
|
16
|
+
Classifier: Programming Language :: Python :: 3
|
|
17
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
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 :: System :: Distributed Computing
|
|
25
|
+
Classifier: Typing :: Typed
|
|
26
|
+
Requires-Python: >=3.9
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
License-File: LICENSE
|
|
29
|
+
Requires-Dist: requests>=2.31
|
|
30
|
+
Requires-Dist: PyYAML>=6.0
|
|
31
|
+
Provides-Extra: dev
|
|
32
|
+
Requires-Dist: pytest>=8.0; extra == "dev"
|
|
33
|
+
Requires-Dist: responses>=0.25; extra == "dev"
|
|
34
|
+
Dynamic: license-file
|
|
35
|
+
|
|
36
|
+
# ddpsrun
|
|
37
|
+
|
|
38
|
+
**Submit a GPU job. Get results back. No `kubectl`, no cloud account, no VM to babysit.**
|
|
39
|
+
|
|
40
|
+
`ddpsrun` is the front door to PACSrun, a Kubernetes-native batch job system that rents GPUs from
|
|
41
|
+
whichever vendor is cheapest for the shape you asked for — AWS, GCP or RunPod — runs your code
|
|
42
|
+
there, and puts the results in object storage. You describe the job; you never see the machine.
|
|
43
|
+
|
|
44
|
+
```console
|
|
45
|
+
$ ddpsrun login <token>
|
|
46
|
+
$ ddpsrun estimate -f job.yaml
|
|
47
|
+
$ ddpsrun submit -f job.yaml
|
|
48
|
+
$ ddpsrun logs <job-id> --follow
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
## Why it exists
|
|
52
|
+
|
|
53
|
+
A researcher who wants a GPU for two hours has three bad options today: get a cloud account and
|
|
54
|
+
learn its console, get `kubectl` access to somebody's cluster, or ask a person. Each of those
|
|
55
|
+
teaches infrastructure to somebody whose job is not infrastructure.
|
|
56
|
+
|
|
57
|
+
The alternative here is that **a batch job is the unit**. You hand over a job description and a
|
|
58
|
+
program. The platform decides which machine to rent, rents it, runs your code, brings the output
|
|
59
|
+
home, and hands the machine back. When it goes wrong you get an exit code and a sentence, not a
|
|
60
|
+
half-configured VM.
|
|
61
|
+
|
|
62
|
+
## Install
|
|
63
|
+
|
|
64
|
+
```console
|
|
65
|
+
pip install ddpsrun
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Two dependencies, `requests` and `PyYAML`, and that is deliberate: this package installs next to
|
|
69
|
+
your research code, so every extra dependency is one that can fight with something you have
|
|
70
|
+
pinned. No `click`, no `rich`, no `pydantic`.
|
|
71
|
+
|
|
72
|
+
Python 3.9 or newer.
|
|
73
|
+
|
|
74
|
+
## Configure
|
|
75
|
+
|
|
76
|
+
`ddpsrun` needs a server URL and a token. Ask whoever runs your deployment for both.
|
|
77
|
+
|
|
78
|
+
```console
|
|
79
|
+
$ export DDPSRUN_SERVER=https://<your-gateway-url>
|
|
80
|
+
$ ddpsrun login <token>
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
`login` writes them to `~/.config/ddpsrun/config.json` with mode 0600, or to
|
|
84
|
+
`$XDG_CONFIG_HOME/ddpsrun` when that is set. For CI, where a file is the wrong shape, set
|
|
85
|
+
`DDPSRUN_TOKEN` in the environment and skip `login` entirely.
|
|
86
|
+
|
|
87
|
+
## The commands
|
|
88
|
+
|
|
89
|
+
| | |
|
|
90
|
+
|---|---|
|
|
91
|
+
| `login` / `logout` | store and remove the server URL and token |
|
|
92
|
+
| `explain` | what this deployment can do, in prose — run it first |
|
|
93
|
+
| `schema` | the job description's fields and their types |
|
|
94
|
+
| `estimate` | what a job would cost and how long it would take, before you spend anything |
|
|
95
|
+
| `validate` | check a job description without submitting it |
|
|
96
|
+
| `submit` | submit it |
|
|
97
|
+
| `status` / `watch` | where a job is now; `watch` follows until it ends |
|
|
98
|
+
| `logs` | your program's own output, `--follow` to stream |
|
|
99
|
+
| `stats` | GPU utilisation, memory, temperature and power while the job runs |
|
|
100
|
+
| `cancel` | stop a job and hand its machine back |
|
|
101
|
+
|
|
102
|
+
Exit codes are contractual: **0** it worked, **1** the server refused or a `validate` finding would
|
|
103
|
+
stop the job, **2** the command was wrong or there are no credentials.
|
|
104
|
+
|
|
105
|
+
## Writing a job
|
|
106
|
+
|
|
107
|
+
A job description is YAML:
|
|
108
|
+
|
|
109
|
+
```yaml
|
|
110
|
+
image: nvcr.io/nvidia/pytorch:24.10-py3
|
|
111
|
+
command: ["/bin/bash", "-c"]
|
|
112
|
+
args:
|
|
113
|
+
- |
|
|
114
|
+
python train.py --epochs 3
|
|
115
|
+
resources:
|
|
116
|
+
gpus:
|
|
117
|
+
name: L4
|
|
118
|
+
count: 1
|
|
119
|
+
resultPath: s3://<your-bucket>/runs/my-experiment/
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
Run `ddpsrun schema` for every field and `ddpsrun explain` for what your deployment allows.
|
|
123
|
+
|
|
124
|
+
**Do not guess the GPU or the runtime.** `ddpsrun estimate` answers both from measured data, and
|
|
125
|
+
guessing is how a job ends up on a card several times more expensive than it needed.
|
|
126
|
+
|
|
127
|
+
## Using it from an AI coding agent
|
|
128
|
+
|
|
129
|
+
This repository ships a [Claude Code](https://claude.com/claude-code) plugin. It teaches an agent
|
|
130
|
+
five steps: read what the deployment allows, read your repository against the script contract,
|
|
131
|
+
estimate rather than assume, validate and stop on a finding, and submit only after you approve.
|
|
132
|
+
|
|
133
|
+
```
|
|
134
|
+
/plugin marketplace add ddps-lab/pacsrun-gw
|
|
135
|
+
/plugin install ddpsrun
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
The plugin's reference documents are in [`agent/references/`](agent/references/). The one worth
|
|
139
|
+
reading yourself is [`script-contract.md`](agent/references/script-contract.md): a list of the ways
|
|
140
|
+
a long training run dies in its last minute, each one taken from a run that did.
|
|
141
|
+
|
|
142
|
+
## What this is not
|
|
143
|
+
|
|
144
|
+
- **Not an interactive machine.** There is no SSH and no shell into a running job. You submit a
|
|
145
|
+
program and read its output. If you need to poke at a live container, this is the wrong tool
|
|
146
|
+
today.
|
|
147
|
+
- **Not a scheduler you host.** `ddpsrun` is a client. Somebody has to run the gateway and the
|
|
148
|
+
PACSrun operator; see [`docs/`](docs/) if that somebody is you.
|
|
149
|
+
- **Not free of limits.** A job's credentials for writing results last twelve hours, which is
|
|
150
|
+
AWS's hard maximum for a role session and not a setting anyone can raise. A run longer than that
|
|
151
|
+
must checkpoint and resume, and the driver warns half an hour before the deadline.
|
|
152
|
+
|
|
153
|
+
## Repository layout
|
|
154
|
+
|
|
155
|
+
| | |
|
|
156
|
+
|---|---|
|
|
157
|
+
| `cli/` | the `ddpsrun` package published to PyPI |
|
|
158
|
+
| `server/` | the gateway: authenticates users, talks to Kubernetes |
|
|
159
|
+
| `agent/` | the Claude Code plugin — one skill, four reference documents |
|
|
160
|
+
| `ui/` | a small static web front end (`index.html`, `app.js`, `style.css`) |
|
|
161
|
+
| `terraform/` | the deployment: Lambda, Cognito, S3, CloudFront |
|
|
162
|
+
| `docs/` | seventeen design documents, numbered in reading order |
|
|
163
|
+
|
|
164
|
+
## Development
|
|
165
|
+
|
|
166
|
+
```console
|
|
167
|
+
$ pip install -e 'cli/[dev]' # the client
|
|
168
|
+
$ pip install -e 'server/[dev]' # the gateway
|
|
169
|
+
$ pytest cli/tests server/tests
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
Both halves live in one repository so the two sides of an API change land in one commit. They share
|
|
173
|
+
nothing else: the client never imports the Kubernetes libraries, and the server never imports the
|
|
174
|
+
browser login flow.
|
|
175
|
+
|
|
176
|
+
**No account identifiers in this repository.** Documents and code use placeholders —
|
|
177
|
+
`<ACCOUNT_ID>`, `<RESULT_BUCKET>` — and CI checks every push for AWS account numbers, access keys,
|
|
178
|
+
GitHub and RunPod tokens, private keys, and Google OAuth secrets.
|
|
179
|
+
|
|
180
|
+
## License
|
|
181
|
+
|
|
182
|
+
Apache-2.0. See [`LICENSE`](LICENSE).
|
ddpsrun-0.1.0/README.md
ADDED
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
# ddpsrun
|
|
2
|
+
|
|
3
|
+
**Submit a GPU job. Get results back. No `kubectl`, no cloud account, no VM to babysit.**
|
|
4
|
+
|
|
5
|
+
`ddpsrun` is the front door to PACSrun, a Kubernetes-native batch job system that rents GPUs from
|
|
6
|
+
whichever vendor is cheapest for the shape you asked for — AWS, GCP or RunPod — runs your code
|
|
7
|
+
there, and puts the results in object storage. You describe the job; you never see the machine.
|
|
8
|
+
|
|
9
|
+
```console
|
|
10
|
+
$ ddpsrun login <token>
|
|
11
|
+
$ ddpsrun estimate -f job.yaml
|
|
12
|
+
$ ddpsrun submit -f job.yaml
|
|
13
|
+
$ ddpsrun logs <job-id> --follow
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Why it exists
|
|
17
|
+
|
|
18
|
+
A researcher who wants a GPU for two hours has three bad options today: get a cloud account and
|
|
19
|
+
learn its console, get `kubectl` access to somebody's cluster, or ask a person. Each of those
|
|
20
|
+
teaches infrastructure to somebody whose job is not infrastructure.
|
|
21
|
+
|
|
22
|
+
The alternative here is that **a batch job is the unit**. You hand over a job description and a
|
|
23
|
+
program. The platform decides which machine to rent, rents it, runs your code, brings the output
|
|
24
|
+
home, and hands the machine back. When it goes wrong you get an exit code and a sentence, not a
|
|
25
|
+
half-configured VM.
|
|
26
|
+
|
|
27
|
+
## Install
|
|
28
|
+
|
|
29
|
+
```console
|
|
30
|
+
pip install ddpsrun
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Two dependencies, `requests` and `PyYAML`, and that is deliberate: this package installs next to
|
|
34
|
+
your research code, so every extra dependency is one that can fight with something you have
|
|
35
|
+
pinned. No `click`, no `rich`, no `pydantic`.
|
|
36
|
+
|
|
37
|
+
Python 3.9 or newer.
|
|
38
|
+
|
|
39
|
+
## Configure
|
|
40
|
+
|
|
41
|
+
`ddpsrun` needs a server URL and a token. Ask whoever runs your deployment for both.
|
|
42
|
+
|
|
43
|
+
```console
|
|
44
|
+
$ export DDPSRUN_SERVER=https://<your-gateway-url>
|
|
45
|
+
$ ddpsrun login <token>
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
`login` writes them to `~/.config/ddpsrun/config.json` with mode 0600, or to
|
|
49
|
+
`$XDG_CONFIG_HOME/ddpsrun` when that is set. For CI, where a file is the wrong shape, set
|
|
50
|
+
`DDPSRUN_TOKEN` in the environment and skip `login` entirely.
|
|
51
|
+
|
|
52
|
+
## The commands
|
|
53
|
+
|
|
54
|
+
| | |
|
|
55
|
+
|---|---|
|
|
56
|
+
| `login` / `logout` | store and remove the server URL and token |
|
|
57
|
+
| `explain` | what this deployment can do, in prose — run it first |
|
|
58
|
+
| `schema` | the job description's fields and their types |
|
|
59
|
+
| `estimate` | what a job would cost and how long it would take, before you spend anything |
|
|
60
|
+
| `validate` | check a job description without submitting it |
|
|
61
|
+
| `submit` | submit it |
|
|
62
|
+
| `status` / `watch` | where a job is now; `watch` follows until it ends |
|
|
63
|
+
| `logs` | your program's own output, `--follow` to stream |
|
|
64
|
+
| `stats` | GPU utilisation, memory, temperature and power while the job runs |
|
|
65
|
+
| `cancel` | stop a job and hand its machine back |
|
|
66
|
+
|
|
67
|
+
Exit codes are contractual: **0** it worked, **1** the server refused or a `validate` finding would
|
|
68
|
+
stop the job, **2** the command was wrong or there are no credentials.
|
|
69
|
+
|
|
70
|
+
## Writing a job
|
|
71
|
+
|
|
72
|
+
A job description is YAML:
|
|
73
|
+
|
|
74
|
+
```yaml
|
|
75
|
+
image: nvcr.io/nvidia/pytorch:24.10-py3
|
|
76
|
+
command: ["/bin/bash", "-c"]
|
|
77
|
+
args:
|
|
78
|
+
- |
|
|
79
|
+
python train.py --epochs 3
|
|
80
|
+
resources:
|
|
81
|
+
gpus:
|
|
82
|
+
name: L4
|
|
83
|
+
count: 1
|
|
84
|
+
resultPath: s3://<your-bucket>/runs/my-experiment/
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
Run `ddpsrun schema` for every field and `ddpsrun explain` for what your deployment allows.
|
|
88
|
+
|
|
89
|
+
**Do not guess the GPU or the runtime.** `ddpsrun estimate` answers both from measured data, and
|
|
90
|
+
guessing is how a job ends up on a card several times more expensive than it needed.
|
|
91
|
+
|
|
92
|
+
## Using it from an AI coding agent
|
|
93
|
+
|
|
94
|
+
This repository ships a [Claude Code](https://claude.com/claude-code) plugin. It teaches an agent
|
|
95
|
+
five steps: read what the deployment allows, read your repository against the script contract,
|
|
96
|
+
estimate rather than assume, validate and stop on a finding, and submit only after you approve.
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
/plugin marketplace add ddps-lab/pacsrun-gw
|
|
100
|
+
/plugin install ddpsrun
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
The plugin's reference documents are in [`agent/references/`](agent/references/). The one worth
|
|
104
|
+
reading yourself is [`script-contract.md`](agent/references/script-contract.md): a list of the ways
|
|
105
|
+
a long training run dies in its last minute, each one taken from a run that did.
|
|
106
|
+
|
|
107
|
+
## What this is not
|
|
108
|
+
|
|
109
|
+
- **Not an interactive machine.** There is no SSH and no shell into a running job. You submit a
|
|
110
|
+
program and read its output. If you need to poke at a live container, this is the wrong tool
|
|
111
|
+
today.
|
|
112
|
+
- **Not a scheduler you host.** `ddpsrun` is a client. Somebody has to run the gateway and the
|
|
113
|
+
PACSrun operator; see [`docs/`](docs/) if that somebody is you.
|
|
114
|
+
- **Not free of limits.** A job's credentials for writing results last twelve hours, which is
|
|
115
|
+
AWS's hard maximum for a role session and not a setting anyone can raise. A run longer than that
|
|
116
|
+
must checkpoint and resume, and the driver warns half an hour before the deadline.
|
|
117
|
+
|
|
118
|
+
## Repository layout
|
|
119
|
+
|
|
120
|
+
| | |
|
|
121
|
+
|---|---|
|
|
122
|
+
| `cli/` | the `ddpsrun` package published to PyPI |
|
|
123
|
+
| `server/` | the gateway: authenticates users, talks to Kubernetes |
|
|
124
|
+
| `agent/` | the Claude Code plugin — one skill, four reference documents |
|
|
125
|
+
| `ui/` | a small static web front end (`index.html`, `app.js`, `style.css`) |
|
|
126
|
+
| `terraform/` | the deployment: Lambda, Cognito, S3, CloudFront |
|
|
127
|
+
| `docs/` | seventeen design documents, numbered in reading order |
|
|
128
|
+
|
|
129
|
+
## Development
|
|
130
|
+
|
|
131
|
+
```console
|
|
132
|
+
$ pip install -e 'cli/[dev]' # the client
|
|
133
|
+
$ pip install -e 'server/[dev]' # the gateway
|
|
134
|
+
$ pytest cli/tests server/tests
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Both halves live in one repository so the two sides of an API change land in one commit. They share
|
|
138
|
+
nothing else: the client never imports the Kubernetes libraries, and the server never imports the
|
|
139
|
+
browser login flow.
|
|
140
|
+
|
|
141
|
+
**No account identifiers in this repository.** Documents and code use placeholders —
|
|
142
|
+
`<ACCOUNT_ID>`, `<RESULT_BUCKET>` — and CI checks every push for AWS account numbers, access keys,
|
|
143
|
+
GitHub and RunPod tokens, private keys, and Google OAuth secrets.
|
|
144
|
+
|
|
145
|
+
## License
|
|
146
|
+
|
|
147
|
+
Apache-2.0. See [`LICENSE`](LICENSE).
|