nodus-compute 0.1.0__tar.gz

nodus_compute-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Nodus, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

nodus_compute-0.1.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: nodus_compute
+Version: 0.1.0
+Summary: Python client for the Nodus workload execution API
+Author: Nodus, Inc.
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://nodus.run
+Project-URL: Documentation, https://nodus.run/docs/
+Project-URL: Source, https://github.com/Nodus-compute/Nodus-sdk-python
+Project-URL: Issues, https://github.com/Nodus-compute/Nodus-sdk-python/issues
+Keywords: gpu,machine-learning,training,fine-tuning,compute
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Dynamic: license-file
+
+# Nodus Python SDK
+
+Run a training job on rented GPUs from Python. Nodus places the work on the
+cheapest capacity that fits, checkpoints it, and resumes it if the machine is
+taken back — so a fine-tune that would have died at hour six finishes.
+
+```python
+import nodus
+
+with nodus.Client() as client:
+    wl = client.run(command=["python", "train.py"], budget=20)
+    print(client.wait(wl.id).status)
+```
+
+## Install
+
+```bash
+pip install nodus_compute
+```
+
+The distribution is `nodus_compute`; the import is `nodus` — the same split as
+`pip install scikit-learn` and `import sklearn`.
+
+## Point it at your account
+
+Two settings. Sign in at <https://nodus.run/console/>, create an API key — it is
+shown once — and the console's quickstart comes with both already filled in.
+
+```bash
+export NODUS_API_KEY=nk_live_…
+export NODUS_BASE_URL=https://…
+```
+
+Or pass them directly: `nodus.Client(api_key=…, base_url=…)`.
+
+There is no built-in address. With neither setting the client raises
+`ConfigurationError` before it opens a socket, naming what is missing — it does
+not dial a guess and hand you a name-lookup error.
+
+## Running work
+
+`run()` takes a flat brief and returns a `Workload`:
+
+```python
+import nodus
+
+with nodus.Client() as client:
+    wl = client.run(
+        image="python:3.11-slim",
+        command=["python", "train.py", "--epochs", "3"],
+        peak_memory_gb=24,          # picks capacity that fits
+        expected_runtime_hours=6,   # informs the estimate
+        budget=40,                  # a ceiling, not a reservation
+    )
+
+    done = client.wait(wl.id)       # polls until the run is over
+    print(done.status, done.cost_now_usd)
+```
+
+Only `command` is required. Everything else narrows the search or bounds the
+cost; omit `budget` and the run is uncapped.
+
+**Your image must be able to fetch a small binary** — it needs `curl`, `wget`,
+or `python3` on the PATH. Most ML images have one. A bare `ubuntu` image has
+none of them, and a machine that cannot fetch the runner is a machine you are
+billed for while it does nothing.
+
+## Waiting
+
+`wait()` polls until the workload is terminal and **has no deadline of its
+own**. An 18-hour run is normal, and a client that gave up on one would not stop
+it — the work would carry on and keep billing while your program believed it had
+failed. A transient network failure does not end the wait either; only a
+permanent one (a revoked key, an unknown workload) is raised.
+
+Pass `timeout_seconds=` if you want a bound. It ends the *waiting*, not the run:
+`APITimeoutError` is raised, the workload continues, and `.cancel()` is what
+stops it.
+
+## Watching it
+
+```python
+for event in client.stream_events(wl.id):
+    print(event.type, event.message)
+
+print(client.logs(wl.id))           # the job's own stdout and stderr
+print(wl.refresh().cost_now_usd)    # charged plus what is accruing right now
+```
+
+## Async
+
+`AsyncClient` mirrors `Client` method for method:
+
+```python
+async with nodus.AsyncClient() as client:
+    wl = await client.run(command=["python", "train.py"])
+    done = await client.wait(wl.id)
+```
+
+## Errors
+
+Every failure is a subclass of `NodusError`, so one `except` catches the lot:
+
+| Raised | When |
+|---|---|
+| `ConfigurationError` | a setting is missing, before any request |
+| `AuthenticationError` | the key is wrong or revoked |
+| `ValidationError` | the brief was rejected, with the reason |
+| `BudgetExceededError` | the run would pass your account's spend cap |
+| `CapacityUnavailableError` | nothing in the market fits the brief |
+| `NotFoundError` | no such workload |
+| `RateLimitError` | too many requests; honours `Retry-After` |
+| `APIConnectionError` / `APITimeoutError` | the network, not the API |
+
+## Command line
+
+```bash
+nodus run --command "python train.py" --budget 20
+nodus status wl_…
+nodus logs wl_…
+```
+
+## Licence
+
+Apache-2.0. See [LICENSE](./LICENSE).

nodus_compute-0.1.0/README.md

@@ -0,0 +1,125 @@
+# Nodus Python SDK
+
+Run a training job on rented GPUs from Python. Nodus places the work on the
+cheapest capacity that fits, checkpoints it, and resumes it if the machine is
+taken back — so a fine-tune that would have died at hour six finishes.
+
+```python
+import nodus
+
+with nodus.Client() as client:
+    wl = client.run(command=["python", "train.py"], budget=20)
+    print(client.wait(wl.id).status)
+```
+
+## Install
+
+```bash
+pip install nodus_compute
+```
+
+The distribution is `nodus_compute`; the import is `nodus` — the same split as
+`pip install scikit-learn` and `import sklearn`.
+
+## Point it at your account
+
+Two settings. Sign in at <https://nodus.run/console/>, create an API key — it is
+shown once — and the console's quickstart comes with both already filled in.
+
+```bash
+export NODUS_API_KEY=nk_live_…
+export NODUS_BASE_URL=https://…
+```
+
+Or pass them directly: `nodus.Client(api_key=…, base_url=…)`.
+
+There is no built-in address. With neither setting the client raises
+`ConfigurationError` before it opens a socket, naming what is missing — it does
+not dial a guess and hand you a name-lookup error.
+
+## Running work
+
+`run()` takes a flat brief and returns a `Workload`:
+
+```python
+import nodus
+
+with nodus.Client() as client:
+    wl = client.run(
+        image="python:3.11-slim",
+        command=["python", "train.py", "--epochs", "3"],
+        peak_memory_gb=24,          # picks capacity that fits
+        expected_runtime_hours=6,   # informs the estimate
+        budget=40,                  # a ceiling, not a reservation
+    )
+
+    done = client.wait(wl.id)       # polls until the run is over
+    print(done.status, done.cost_now_usd)
+```
+
+Only `command` is required. Everything else narrows the search or bounds the
+cost; omit `budget` and the run is uncapped.
+
+**Your image must be able to fetch a small binary** — it needs `curl`, `wget`,
+or `python3` on the PATH. Most ML images have one. A bare `ubuntu` image has
+none of them, and a machine that cannot fetch the runner is a machine you are
+billed for while it does nothing.
+
+## Waiting
+
+`wait()` polls until the workload is terminal and **has no deadline of its
+own**. An 18-hour run is normal, and a client that gave up on one would not stop
+it — the work would carry on and keep billing while your program believed it had
+failed. A transient network failure does not end the wait either; only a
+permanent one (a revoked key, an unknown workload) is raised.
+
+Pass `timeout_seconds=` if you want a bound. It ends the *waiting*, not the run:
+`APITimeoutError` is raised, the workload continues, and `.cancel()` is what
+stops it.
+
+## Watching it
+
+```python
+for event in client.stream_events(wl.id):
+    print(event.type, event.message)
+
+print(client.logs(wl.id))           # the job's own stdout and stderr
+print(wl.refresh().cost_now_usd)    # charged plus what is accruing right now
+```
+
+## Async
+
+`AsyncClient` mirrors `Client` method for method:
+
+```python
+async with nodus.AsyncClient() as client:
+    wl = await client.run(command=["python", "train.py"])
+    done = await client.wait(wl.id)
+```
+
+## Errors
+
+Every failure is a subclass of `NodusError`, so one `except` catches the lot:
+
+| Raised | When |
+|---|---|
+| `ConfigurationError` | a setting is missing, before any request |
+| `AuthenticationError` | the key is wrong or revoked |
+| `ValidationError` | the brief was rejected, with the reason |
+| `BudgetExceededError` | the run would pass your account's spend cap |
+| `CapacityUnavailableError` | nothing in the market fits the brief |
+| `NotFoundError` | no such workload |
+| `RateLimitError` | too many requests; honours `Retry-After` |
+| `APIConnectionError` / `APITimeoutError` | the network, not the API |
+
+## Command line
+
+```bash
+nodus run --command "python train.py" --budget 20
+nodus status wl_…
+nodus logs wl_…
+```
+
+## Licence
+
+Apache-2.0. See [LICENSE](./LICENSE).