sigmoid-ferry 0.1.0__tar.gz

sigmoid_ferry-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 [yyyy] [name of copyright owner]
+
+   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.

sigmoid_ferry-0.1.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: sigmoid-ferry
+Version: 0.1.0
+Summary: Run your Hunch experiments on a GPU machine over SSH, and bring every run home.
+Keywords: machine-learning,gpu,ssh,experiment-tracking,remote-training
+Author: Usmon N
+Author-email: Usmon N <rainxch.dev@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Dist: sigmoid-hunch>=0.4.0
+Requires-Dist: paramiko>=5.1.0
+Requires-Python: >=3.11
+Project-URL: Repository, https://github.com/sigmoid-ide/ferry
+Project-URL: Issues, https://github.com/sigmoid-ide/ferry/issues
+Description-Content-Type: text/markdown
+
+# Ferry
+
+**Run your Hunch experiments on a GPU machine, and bring every run home.**
+
+```bash
+ferry add mybox user@gpu-box
+ferry run --on mybox -m "bigger batch on the 3090" -- python train.py
+```
+
+Ferry sends your code to the machine, builds the environment there, starts the run so it survives a dropped
+connection, and copies it back into `.hunch/` while it trains. `hunch log` and the PyCharm and VS Code plugins show
+it like any other run.
+
+Status: 0.1, for your own machines over SSH. Part of [Sigmoid IDE](https://github.com/sigmoid-ide).
+
+## Install
+
+```bash
+pip install sigmoid-ferry
+```
+
+That gives you the `ferry` command, with Hunch. It also installs as a tool of its own: `uv tool install sigmoid-ferry`.
+
+## What the machine needs
+
+Linux (x86_64 or aarch64), SSH and `python3`. Nothing is installed system-wide: Ferry keeps everything in `~/.ferry`,
+including [uv](https://github.com/astral-sh/uv), which it downloads once and checks against a pinned checksum.
+
+## Running
+
+`ferry add` shows the machine's host key the first time and pins it; a changed key stops Ferry until you remove the
+old one. Ferry uses your SSH setup as it is: `~/.ssh/config` (with `ProxyJump` for a machine behind a jump host),
+your keys and ssh-agent. A key with a passphrase is asked for in the terminal.
+
+`ferry run` records the run on your computer first (code, git branch, the run it builds on), then:
+
+- builds the environment on the machine from `requirements.txt`, or else from the packages in the project's own
+  Python (an activated environment, or `.venv`), with torch matched to the machine's driver. Each environment is
+  built once and reused;
+- sends only the code files the machine does not have yet;
+- starts the run in the same project folder you started it from, so relative paths work;
+- copies the run home while it trains, and checks every file when it ends.
+
+## Tokens and GPUs
+
+Give a run what it needs from your environment with `--env`, and pick its GPUs with `--gpus`:
+
+```bash
+ferry run --on mybox --env HF_TOKEN --env WANDB_MODE=offline --gpus 1 -- python train.py
+```
+
+`--env NAME` sends the value `NAME` has here, so a token is never typed out or left in your shell history. It is
+handed to the run in memory and never saved in a file, on the machine or in `.hunch/`. `--gpus` takes the numbers
+`nvidia-smi` shows. Ferry refuses a GPU the machine does not have, which CUDA would answer by quietly running on the
+CPU, and says when another program already uses a GPU the run gets.
+
+## Data and outputs
+
+Only your code goes to the machine on its own. Send data with `--data`:
+
+```bash
+ferry run --on mybox --data data/ -- python train.py
+```
+
+Data goes into a folder the project keeps on the machine and appears in every run's folder at the same path, so
+`open("data/train.bin")` works there as it does here. It is sent once: next time only new or changed files go.
+
+What a run writes (checkpoints, plots) stays on the machine. Ferry lists it when the run ends; bring it home with:
+
+```bash
+ferry pull a7f3                       # what run a7f3 wrote
+ferry pull a7f3 checkpoints --to out/
+```
+
+## When the connection drops
+
+The run keeps going. Ctrl+C stops copying, never the run. `ferry attach a7f3` picks the copy up again,
+`ferry stop a7f3` stops the run (and everything it started; after 30 seconds it is killed), and `ferry ps` asks each
+machine how its runs are doing. A run whose process on the machine dies without an end is marked crashed. If a
+machine is gone for good, `ferry forget a7f3` stops counting its run as running, and Hunch shows it as lost; should the
+machine come back, `ferry attach a7f3` picks the run up again.
+
+## Disk space
+
+```bash
+ferry clean mybox             # environments no run has asked for in 14 days
+ferry clean mybox --outputs   # and what this project's ended runs wrote there, except runs you marked keep
+```
+
+Both say what they would remove and how much space that frees, and ask first. An environment is built again when a run
+needs it.
+
+## What stays where
+
+Nothing secret goes into `.hunch/` or to the machine: no keys, no passwords. Tokens passed with `--env` exist only in
+the run's memory. Ferry's own settings (the machines
+you added and their host keys) are in `%APPDATA%\ferry` on Windows and `~/.config/ferry` elsewhere.

sigmoid_ferry-0.1.0/README.md

@@ -0,0 +1,97 @@
+# Ferry
+
+**Run your Hunch experiments on a GPU machine, and bring every run home.**
+
+```bash
+ferry add mybox user@gpu-box
+ferry run --on mybox -m "bigger batch on the 3090" -- python train.py
+```
+
+Ferry sends your code to the machine, builds the environment there, starts the run so it survives a dropped
+connection, and copies it back into `.hunch/` while it trains. `hunch log` and the PyCharm and VS Code plugins show
+it like any other run.
+
+Status: 0.1, for your own machines over SSH. Part of [Sigmoid IDE](https://github.com/sigmoid-ide).
+
+## Install
+
+```bash
+pip install sigmoid-ferry
+```
+
+That gives you the `ferry` command, with Hunch. It also installs as a tool of its own: `uv tool install sigmoid-ferry`.
+
+## What the machine needs
+
+Linux (x86_64 or aarch64), SSH and `python3`. Nothing is installed system-wide: Ferry keeps everything in `~/.ferry`,
+including [uv](https://github.com/astral-sh/uv), which it downloads once and checks against a pinned checksum.
+
+## Running
+
+`ferry add` shows the machine's host key the first time and pins it; a changed key stops Ferry until you remove the
+old one. Ferry uses your SSH setup as it is: `~/.ssh/config` (with `ProxyJump` for a machine behind a jump host),
+your keys and ssh-agent. A key with a passphrase is asked for in the terminal.
+
+`ferry run` records the run on your computer first (code, git branch, the run it builds on), then:
+
+- builds the environment on the machine from `requirements.txt`, or else from the packages in the project's own
+  Python (an activated environment, or `.venv`), with torch matched to the machine's driver. Each environment is
+  built once and reused;
+- sends only the code files the machine does not have yet;
+- starts the run in the same project folder you started it from, so relative paths work;
+- copies the run home while it trains, and checks every file when it ends.
+
+## Tokens and GPUs
+
+Give a run what it needs from your environment with `--env`, and pick its GPUs with `--gpus`:
+
+```bash
+ferry run --on mybox --env HF_TOKEN --env WANDB_MODE=offline --gpus 1 -- python train.py
+```
+
+`--env NAME` sends the value `NAME` has here, so a token is never typed out or left in your shell history. It is
+handed to the run in memory and never saved in a file, on the machine or in `.hunch/`. `--gpus` takes the numbers
+`nvidia-smi` shows. Ferry refuses a GPU the machine does not have, which CUDA would answer by quietly running on the
+CPU, and says when another program already uses a GPU the run gets.
+
+## Data and outputs
+
+Only your code goes to the machine on its own. Send data with `--data`:
+
+```bash
+ferry run --on mybox --data data/ -- python train.py
+```
+
+Data goes into a folder the project keeps on the machine and appears in every run's folder at the same path, so
+`open("data/train.bin")` works there as it does here. It is sent once: next time only new or changed files go.
+
+What a run writes (checkpoints, plots) stays on the machine. Ferry lists it when the run ends; bring it home with:
+
+```bash
+ferry pull a7f3                       # what run a7f3 wrote
+ferry pull a7f3 checkpoints --to out/
+```
+
+## When the connection drops
+
+The run keeps going. Ctrl+C stops copying, never the run. `ferry attach a7f3` picks the copy up again,
+`ferry stop a7f3` stops the run (and everything it started; after 30 seconds it is killed), and `ferry ps` asks each
+machine how its runs are doing. A run whose process on the machine dies without an end is marked crashed. If a
+machine is gone for good, `ferry forget a7f3` stops counting its run as running, and Hunch shows it as lost; should the
+machine come back, `ferry attach a7f3` picks the run up again.
+
+## Disk space
+
+```bash
+ferry clean mybox             # environments no run has asked for in 14 days
+ferry clean mybox --outputs   # and what this project's ended runs wrote there, except runs you marked keep
+```
+
+Both say what they would remove and how much space that frees, and ask first. An environment is built again when a run
+needs it.
+
+## What stays where
+
+Nothing secret goes into `.hunch/` or to the machine: no keys, no passwords. Tokens passed with `--env` exist only in
+the run's memory. Ferry's own settings (the machines
+you added and their host keys) are in `%APPDATA%\ferry` on Windows and `~/.config/ferry` elsewhere.

sigmoid_ferry-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[project]
+name = "sigmoid-ferry"
+version = "0.1.0"
+description = "Run your Hunch experiments on a GPU machine over SSH, and bring every run home."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.11"
+dependencies = [
+    "sigmoid-hunch>=0.4.0",
+    "paramiko>=5.1.0",
+]
+keywords = [
+    "machine-learning",
+    "gpu",
+    "ssh",
+    "experiment-tracking",
+    "remote-training",
+]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+
+[[project.authors]]
+name = "Usmon N"
+email = "rainxch.dev@gmail.com"
+
+[project.scripts]
+ferry = "ferry.cli:main"
+
+[project.urls]
+Repository = "https://github.com/sigmoid-ide/ferry"
+Issues = "https://github.com/sigmoid-ide/ferry/issues"
+
+[build-system]
+requires = ["uv_build>=0.11.16,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "ferry"
+
+[dependency-groups]
+dev = ["pytest>=9.2.0"]

sigmoid_ferry-0.1.0/pyproject.toml.orig

@@ -0,0 +1,43 @@
+[project]
+name = "sigmoid-ferry"
+version = "0.1.0"
+description = "Run your Hunch experiments on a GPU machine over SSH, and bring every run home."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Usmon N", email = "rainxch.dev@gmail.com" }
+]
+requires-python = ">=3.11"
+dependencies = [
+    "sigmoid-hunch>=0.4.0",
+    "paramiko>=5.1.0",
+]
+keywords = ["machine-learning", "gpu", "ssh", "experiment-tracking", "remote-training"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+
+[project.scripts]
+ferry = "ferry.cli:main"
+
+[project.urls]
+Repository = "https://github.com/sigmoid-ide/ferry"
+Issues = "https://github.com/sigmoid-ide/ferry/issues"
+
+[build-system]
+requires = ["uv_build>=0.11.16,<0.12.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "ferry"
+
+[dependency-groups]
+dev = [
+    "pytest>=9.2.0",
+]

sigmoid_ferry-0.1.0/src/ferry/__init__.py

@@ -0,0 +1,8 @@
+"""Ferry: run your Hunch experiments on a GPU machine and bring every run home."""
+
+from importlib import metadata as _metadata
+
+try:
+    __version__ = _metadata.version("sigmoid-ferry")
+except _metadata.PackageNotFoundError:
+    __version__ = "0+unknown"

sigmoid_ferry-0.1.0/src/ferry/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+raise SystemExit(main())