xmanager-slurm 0.4.0__tar.gz

xmanager_slurm-0.4.0/.devcontainer.json

@@ -0,0 +1,38 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
+// https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/containers/python-3-miniconda
+{
+  "name": "xm-slurm",
+  "image": "mcr.microsoft.com/vscode/devcontainers/python:3.10",
+  "features": {
+    "ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
+    // TODO(jfarebro): add uv feature when available
+    "ghcr.io/devcontainers-contrib/features/pre-commit:2": {},
+    "ghcr.io/devcontainers-contrib/features/direnv:1": {}
+  },
+  "remoteEnv": {
+    "LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}"
+  },
+  // docker-from-docker suggests using --init in the run args to clean up zombie processes?
+  "runArgs": [
+    "--init",
+    "--network=host"
+  ],
+  // Mount the local docker socket to the container
+  "mounts": [
+    "source=/var/run/docker.sock,target=/var/run/docker-host.sock,type=bind,consistency=cached"
+  ],
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-python.vscode-pylance",
+        "charliermarsh.ruff",
+        "mkhl.direnv"
+      ]
+    }
+  },
+  "postCreateCommand": {
+    // TODO(jfarebro): uv sync when available
+    "pre-commit": "pre-commit install -t commit-msg --install-hooks"
+  }
+}

xmanager_slurm-0.4.0/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+jobs:
+  ci:
+    name: Run CI checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version-file: 'pyproject.toml'
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.0

xmanager_slurm-0.4.0/.github/workflows/deploy-docs.yml

@@ -0,0 +1,55 @@
+name: Deploy Docs
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "xm_slurm/**"
+      - ".github/workflows/deploy-docs.yml"
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          version: "latest"
+
+      - uses: actions/configure-pages@v3
+        id: pages
+    
+      - run: uv sync
+
+      - run: uv run sphinx-build -b html docs docs/_build/html
+
+      - uses: actions/upload-pages-artifact@v1
+        with:
+          path: docs/_build/html
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/deploy-pages@v2
+        id: deployment

xmanager_slurm-0.4.0/.gitignore

@@ -0,0 +1,126 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+.envrc
+.ruff_cache

xmanager_slurm-0.4.0/.pre-commit-config.yaml

@@ -0,0 +1,31 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-ast
+      - id: check-yaml
+      - id: check-toml
+      - id: check-symlinks
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: debug-statements
+      - id: detect-private-key
+        exclude: ^tests/integration/fixtures/slurm/.*
+
+  # Linting
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: "v0.6.9"
+    hooks:
+      - id: ruff
+      - id: ruff-format
+
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    # uv version.
+    rev: 0.4.20
+    hooks:
+      # Update the uv lockfile
+      - id: uv-lock

xmanager_slurm-0.4.0/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "search.exclude": {
+    "uv.lock": true,
+  },
+}

xmanager_slurm-0.4.0/LICENSE.md

@@ -0,0 +1,227 @@
+This work is dual-licensed under Apache 2.0 and MIT License attached below.
+You can choose between one of them if you use this work.
+
+---
+
+The MIT License (MIT)
+=====================
+
+Copyright © `2024` `Jesse Farebrother`
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+---
+
+Apache License
+==============
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### 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.

xmanager_slurm-0.4.0/PKG-INFO

@@ -0,0 +1,26 @@
+Metadata-Version: 2.3
+Name: xmanager-slurm
+Version: 0.4.0
+Summary: Slurm backend for XManager.
+Project-URL: GitHub, https://github.com/jessefarebro/xm-slurm
+Author-email: Jesse Farebrother <jfarebro@cs.mcgill.ca>
+License: MIT
+License-File: LICENSE.md
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: asyncssh>=2.13.2
+Requires-Dist: backoff>=2.2.1
+Requires-Dist: cloudpickle>=3.0.0
+Requires-Dist: humanize>=4.8.0
+Requires-Dist: immutabledict>=3.0.0
+Requires-Dist: jinja2>=3.1.2
+Requires-Dist: more-itertools>=10.2.0
+Requires-Dist: rich>=13.5.2
+Requires-Dist: toml>=0.10.2
+Requires-Dist: xmanager>=0.5.0

xmanager_slurm-0.4.0/README.md

@@ -0,0 +1,65 @@
+# 👨‍🔬 XManager Slurm
+
+<p align="center">
+    <em><a href="https://jessefarebro.github.io/xm-slurm">Documentation</a></em>
+    &nbsp;&nbsp;&bull;&nbsp;&nbsp;
+    <em><code>pip install xmanager-slurm</code></em>
+</p>
+
+<!--
+Badges
+<p align="center">
+    <img alt="build" src="https://github.com/jessefarebro/xm-slurm/actions/workflows/build.yml/badge.svg" />
+    <img alt="mypy" src="https://github.com/jessefarebro/xm-slurm/actions/workflows/mypy.yml/badge.svg" />
+    <img alt="pyright" src="https://github.com/jessefarebro/xm-slurm/actions/workflows/pyright.yml/badge.svg" />
+    <img alt="ruff" src="https://github.com/jessefarebro/xm-slurm/actions/workflows/ruff.yml/badge.svg" />
+    <a href="https://codecov.io/gh/jessefarebro/xm-slurm">
+        <img alt="codecov" src="https://codecov.io/gh/jessefarebro/xm-slurm/branch/main/graph/badge.svg" />
+    </a>
+    <a href="https://pypi.org/project/xmanager-slurm/">
+        <img alt="codecov" src="https://img.shields.io/pypi/pyversions/xmanager-slurm" />
+    </a>
+</p>
+-->
+
+This project implements Slurm support for the XManager experiment launcher.
+The aim is to support a general workflow for idempotent launching of experiments to many Slurm clusters
+through the use of containerization.
+This can provide the following benefits which eliminates various sharp edges of using Slurm for both new and experienced users alike:
+
+1. All development can be done locally and launched on any Slurm cluster without ever interacting with the cluster.
+2. Reproducible experiments (e.g., containerized runtime, code checkpointing, etc.)
+3. Launch scripts are written in __Python__ which makes it easy to perform complex launch configurations like distributed training or job orchestration.
+4. Full control over resource scheduling, choose the cluster that meets your requirements and will schedule your job the fastest.
+
+The following diagram illustrates the general workflow achieved by using XManager Slurm.
+
+
+<picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/workflow-dark.svg">
+    <source media="(prefers-color-scheme: light)" srcset="docs/assets/workflow-light.svg">
+    <img alt="XManager workflow with the Slurm executor." src="docs/assets/workflow-light.svg">
+</picture>
+
+## Alternatives
+
+This project was spawned from what I perceived as a lack of unoppiniated infrastructure for scheduling jobs.
+Contrasting with the most popular libraries here's what XManager + Slurm provides:
+
+* [submitit](https://github.com/facebookincubator/submitit): The submitit plugin is quite popular alongside of the [Hydra](https://hydra.cc/) configuration library. Although these work well in conjunction this might not meet your requirements if and you may consider XMangaer + Slurm if:
+    * You don't want to use Hydra.
+    * You have more complex needs for sweeps beyond the most common usecases of taking the caretesian product amongst a grid of parameters.
+    * You want to schedule jobs on multiple clusters without having to re-configure your development environment.
+    * You want better control over resource scheduling beyond what Slurm can provide.
+    * You want more control over launch configurations / parameter sweeps by being able to write them in Python.
+    * You require launch configurations that go beyond simple single job configurations, e.g., job orchestration, distributed training, etc.
+
+## License
+
+This work is dual-licensed under Apache 2.0 and MIT License.
+You can choose between one of them if you use this work.
+See [LICENSE.md](./LICENSE.md) for more information.
+
+## Disclaimer
+
+This project is not an official Google project. It is not supported by Google and Google specifically disclaims all warranties as to its quality, merchantability, or fitness for a particular purpose.

xmanager_slurm-0.4.0/docs/api/executables.rst

@@ -0,0 +1,16 @@
+Executables
+===================
+
+.. currentmodule:: xm_slurm
+
+.. autosummary::
+
+    Dockerfile
+    DockerImage
+
+Docker
+~~~~~~
+
+.. autoclass:: Dockerfile
+
+.. autoclass:: DockerImage

xmanager_slurm-0.4.0/docs/api/executors.rst

@@ -0,0 +1,15 @@
+Executors
+===================
+
+.. currentmodule:: xm_slurm
+
+.. autosummary::
+
+    Slurm
+
+Slurm
+~~~~~
+
+.. autoclass:: SlurmSpec
+
+.. autoclass:: Slurm

xmanager_slurm-0.4.0/docs/api/packageables.rst

@@ -0,0 +1,36 @@
+Packageables
+===================
+
+.. currentmodule:: xm_slurm
+
+.. autosummary::
+
+    docker_image
+    docker_container
+    uv_container
+    python_container
+    conda_container
+    mamba_container
+
+
+
+Docker
+~~~~~~
+
+.. autofunction:: docker_image
+
+.. autofunction:: docker_container
+
+
+Python
+~~~~~~
+
+.. autofunction:: uv_container
+
+.. autofunction:: python_container
+
+
+Conda
+~~~~~~~~~~~~~
+
+.. autofunction:: mamba_container