lightray 0.2.3__tar.gz → 0.2.5__tar.gz

{lightray-0.2.3 → lightray-0.2.5}/PKG-INFO

@@ -1,26 +1,20 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: lightray
-Version: 0.2.3
+Version: 0.2.5
 Summary: Distribute a LightningCLI hyperparameter search with Ray Tune
-License: MIT
-Author: Ethan Jacob Marx
-Author-email: ethan.marx@ligo.org
-Requires-Python: >=3.9,<4.0
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: jsonargparse[signatures] (>=4.33.2,<5.0.0)
-Requires-Dist: lightning (<=2.4.0)
-Requires-Dist: omegaconf (>=2.3.0,<3.0.0)
-Requires-Dist: pyarrow (>=17.0.0,<18.0.0)
-Requires-Dist: ray[default,tune] (>=2.8.0,<3.0.0)
-Requires-Dist: s3fs (>=2024.9.0,<2025.0.0)
-Requires-Dist: wandb (>=0.18.5,<0.19.0)
+Author-email: Ethan Jacob Marx <ethan.marx@ligo.org>
+Maintainer-email: Will Benoit <william.benoit@ligo.org>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/ML4GW/lightray
+Requires-Python: <3.15,>=3.11
 Description-Content-Type: text/markdown
+Requires-Dist: ray[default,tune]<3,>=2.41
+Requires-Dist: lightning>=2.4.0
+Requires-Dist: s3fs>=2024.9.0
+Requires-Dist: pyarrow>=17
+Requires-Dist: jsonargparse[signatures]<5,>=4.50
+Requires-Dist: omegaconf<3,>=2.3.0
+Requires-Dist: botocore
 
 # lightray
 A CLI for easily integrating `LightningCLI` with `RayTune` hyperparameter optimization
@@ -76,23 +70,21 @@ tune_config:
   num_samples: 1
   reuse_actors: true
 
-# ray.train.RunConfig
+# ray.tune.RunConfig
 run_config:
   name: "my-first-run"
   storage_path: s3://aframe-test/new-tune/
+  # ray.tune.FailureConfig
   failure_config:
-    class_path: ray.train.FailureConfig
-    init_args:
-      max_failures: 1
+    max_failures: 1
+  # ray.tune.CheckpointConfig
   checkpoint_config:
-    class_path: ray.train.CheckpointConfig
-    init_args:
-      num_to_keep: 5
-      checkpoint_score_attribute: "val_loss"
-      checkpoint_score_order: "min"
+    num_to_keep: 5
+    checkpoint_score_attribute: "val_loss"
+    checkpoint_score_order: "min"
   verbose: null
 
-# ray.train.SyncConfig
+# ray.tune.SyncConfig
 sync_config:
   sync_period: 1000
 
@@ -146,4 +138,3 @@ To connect to a remote ray cluster, pass the ip address (using port `10001`) to
 ```console
 lightray --config tune.yaml --ray_init.address ray://{ip}:10001 -- --config cli.yaml
 ```
-

{lightray-0.2.3 → lightray-0.2.5}/README.md

@@ -52,23 +52,21 @@ tune_config:
   num_samples: 1
   reuse_actors: true
 
-# ray.train.RunConfig
+# ray.tune.RunConfig
 run_config:
   name: "my-first-run"
   storage_path: s3://aframe-test/new-tune/
+  # ray.tune.FailureConfig
   failure_config:
-    class_path: ray.train.FailureConfig
-    init_args:
-      max_failures: 1
+    max_failures: 1
+  # ray.tune.CheckpointConfig
   checkpoint_config:
-    class_path: ray.train.CheckpointConfig
-    init_args:
-      num_to_keep: 5
-      checkpoint_score_attribute: "val_loss"
-      checkpoint_score_order: "min"
+    num_to_keep: 5
+    checkpoint_score_attribute: "val_loss"
+    checkpoint_score_order: "min"
   verbose: null
 
-# ray.train.SyncConfig
+# ray.tune.SyncConfig
 sync_config:
   sync_period: 1000
 

{lightray-0.2.3 → lightray-0.2.5}/lightray/callbacks.py

@@ -3,7 +3,7 @@ import time
 from typing import Literal
 
 from botocore.exceptions import ClientError, ConnectTimeoutError
-from ray import train
+from ray import tune
 from ray.tune.integration.pytorch_lightning import TuneReportCheckpointCallback
 
 BOTO_RETRY_EXCEPTIONS = (ClientError, ConnectTimeoutError)
@@ -11,12 +11,12 @@ BOTO_RETRY_EXCEPTIONS = (ClientError, ConnectTimeoutError)
 
 def report_with_retries(metrics, checkpoint=None, retries: int = 10):
     """
-    Call `train.report`, which will persist checkpoints to s3,
+    Call `tune.report`, which will persist checkpoints to s3,
     retrying after any possible errors
     """
     for _ in range(retries):
         try:
-            train.report(metrics=metrics, checkpoint=checkpoint)
+            tune.report(metrics=metrics, checkpoint=checkpoint)
             break
         except BOTO_RETRY_EXCEPTIONS:
             time.sleep(5)
@@ -26,7 +26,7 @@ def report_with_retries(metrics, checkpoint=None, retries: int = 10):
 class LightRayReportCheckpointCallback(TuneReportCheckpointCallback):
     """
     Subclass of Rays TuneReportCheckpointCallback
-    with addition of a retry mechanism to the `train.report`
+    with addition of a retry mechanism to the `tune.report`
     call to handle transient s3 errors.
 
     Adds a `checkpoint_every` parameter to the constructor
@@ -88,6 +88,6 @@ class LightRayReportCheckpointCallback(TuneReportCheckpointCallback):
                 logging.debug(f"Reporting checkpoint on epoch {self.step}")
                 report_with_retries(report_dict, checkpoint=checkpoint)
         else:
-            train.report(metrics=report_dict)
+            tune.report(metrics=report_dict)
 
         self.step += 1

{lightray-0.2.3 → lightray-0.2.5}/lightray/cli.py

@@ -16,7 +16,7 @@ from jsonargparse import (
     capture_parser,
 )
 from lightning.pytorch.cli import LightningCLI
-from ray import train, tune
+from ray import tune
 from ray.tune.integration.pytorch_lightning import TuneCallback
 
 from lightray import fs, utils
@@ -28,11 +28,11 @@ def cli(args=None):
     parser.add_subclass_arguments(TuneCallback, "tune_callback")
     parser.add_class_arguments(tune.TuneConfig, "tune_config")
     parser.add_class_arguments(
-        train.RunConfig, "run_config", skip="storage_filesystem"
+        tune.RunConfig, "run_config", skip="storage_filesystem"
     )
     # TODO: use add class arguments from tune.Tuner directly
     # see https://github.com/omni-us/jsonargparse/issues/609
-    parser.add_class_arguments(train.SyncConfig, "sync_config")
+    parser.add_class_arguments(tune.SyncConfig, "sync_config")
     parser.add_function_arguments(ray.init, "ray_init")
     parser.add_argument(
         "--lightning_cli_cls",
@@ -49,12 +49,12 @@ def cli(args=None):
     parser.add_argument("--cpus_per_trial", type=int, default=1)
 
     parser.link_arguments(
-        "run_config.checkpoint_config.checkpoint_score_attribute",
+        "run_config.checkpoint_config.init_args.checkpoint_score_attribute",
         "tune_callback.init_args.metric",
         apply_on="parse",
     )
     parser.link_arguments(
-        "run_config.checkpoint_config.checkpoint_score_order",
+        "run_config.checkpoint_config.init_args.checkpoint_score_order",
         "tune_callback.init_args.mode",
         apply_on="parse",
     )
@@ -97,7 +97,7 @@ def cli(args=None):
 
     # instantiate tune related classes from config
     # and parse the parameter space
-    cfg_init = parser.instantiate_classes(cfg)
+    cfg_init = parser.instantiate(cfg)
     cfg_init.run_config.sync_config = cfg_init.sync_config
     utils.eval_tune_run_config(cfg_init.param_space)
 

{lightray-0.2.3 → lightray-0.2.5}/lightray/utils.py

@@ -5,7 +5,7 @@ from typing import Type
 from unittest.mock import patch
 
 from lightning.pytorch.cli import LightningCLI
-from ray import train, tune
+from ray import tune
 
 re_tune_func = re.compile(r"^tune.(\w+)\((.+)\)$")
 
@@ -40,7 +40,7 @@ def get_trainable(
             args.append(f"--{key}={val}")
 
         # setup lightning logger path to point to ray trial dir
-        log_dir = train.get_context().get_trial_dir()
+        log_dir = tune.get_context().get_trial_dir()
         args.append(f"--trainer.logger.save_dir={log_dir}")
 
         # get ckpt prefix based on fs
@@ -50,7 +50,7 @@ def get_trainable(
             ckpt_prefix = "s3://"
 
         # restore from checkpoint if available
-        checkpoint = train.get_checkpoint()
+        checkpoint = tune.get_checkpoint()
         ckpt_path = None
         if checkpoint:
             ckpt_path = os.path.join(

lightray-0.2.5/lightray.egg-info/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: lightray
+Version: 0.2.5
+Summary: Distribute a LightningCLI hyperparameter search with Ray Tune
+Author-email: Ethan Jacob Marx <ethan.marx@ligo.org>
+Maintainer-email: Will Benoit <william.benoit@ligo.org>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/ML4GW/lightray
+Requires-Python: <3.15,>=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: ray[default,tune]<3,>=2.41
+Requires-Dist: lightning>=2.4.0
+Requires-Dist: s3fs>=2024.9.0
+Requires-Dist: pyarrow>=17
+Requires-Dist: jsonargparse[signatures]<5,>=4.50
+Requires-Dist: omegaconf<3,>=2.3.0
+Requires-Dist: botocore
+
+# lightray
+A CLI for easily integrating `LightningCLI` with `RayTune` hyperparameter optimization
+
+## Getting Started
+Imagine you have the following lightning `DataModule`, `LightningModule` and `LightningCLI`
+
+```python
+from lightning.pytorch as pl
+
+class DataModule(pl.LightningDataModule):
+    def __init__(self, hidden_dim: int, learning_rate: float, parameter: int):
+        self.parameter = parameter
+        self.hidden_dim = hidden_dim
+        self.learning_rate = learning_rate
+    
+    def train_dataloader(self):
+        ...
+
+class LightningModule(pl.LightningModule):
+    def __init__(self, parameter: int):
+        self.parameter = parameter
+    
+    def training_step(self):
+        ...
+
+class CustomCLI(pl.cli.LightningCLI):
+    def add_arguments_to_parser(self, parser):
+        parser.link_arguments(
+            "data.init_args.parameter", 
+            "model.init_args.parameter", 
+            apply_on="parse"
+        )
+
+```
+
+To launching a hyperparameter tuning job with `RayTune` using this `LightningCLI` can be done by configuring
+a `yaml` that looks like the following
+
+```yaml
+# tune.yaml
+
+# ray.tune.TuneConfig
+tune_config:
+  mode: "min"
+  metric: "val_loss"
+  scheduler: 
+    class_path: ray.tune.schedulers.ASHAScheduler
+    init_args:
+      max_t: 200
+      grace_period: 21
+      reduction_factor: 2
+  num_samples: 1
+  reuse_actors: true
+
+# ray.tune.RunConfig
+run_config:
+  name: "my-first-run"
+  storage_path: s3://aframe-test/new-tune/
+  # ray.tune.FailureConfig
+  failure_config:
+    max_failures: 1
+  # ray.tune.CheckpointConfig
+  checkpoint_config:
+    num_to_keep: 5
+    checkpoint_score_attribute: "val_loss"
+    checkpoint_score_order: "min"
+  verbose: null
+
+# ray.tune.SyncConfig
+sync_config:
+  sync_period: 1000
+
+# ray.init
+ray_init:
+  address: null
+  
+# tune.Tune.param_space
+param_space:
+  model.learning_rate: tune.loguniform(1e-3, 4)
+
+# ray.tune.TuneCallback
+tune_callback:
+  class_path: lightray.callbacks.LightRayReportCheckpointCallback
+  init_args:
+    'on': "validation_end"
+    checkpoint_every: 10
+
+# resources per trial
+cpus_per_trial: 2
+gpus_per_trial: 1
+
+# lightning cli class to tune
+lightning_cli_cls: example.lightning.Cli
+```
+
+Then, launch the tuning job.
+
+```console
+lightray --config tune.yaml -- --config cli.yaml
+```
+
+Any arguments passed after "--" will automatically be forwarded to the specified `LightningCLI` class as if it were being run from the command line. This way, tuning configuration and training configuration can be kept separate. Also, you can easily utilize existing configuration files compatible with your `LightningCLI`.
+
+
+## S3 Support
+In addition, there is automatic support for `s3` storage. Make sure you have set the `AWS_ENDPOINT_URL`, `AWS_ACCESS_KEY_ID`, and `AWS_SECRET_ACCESS_KEY` environment variables. 
+Then, simply pass the path to your bucket with the `s3` prefix (e.g. `s3://{bucket}/{folder}`) to the `run_config.storage_path` argument.
+
+```console
+lightray --config tune.yaml --run_config.storage_path s3://{bucket}/{folder}
+```
+
+There is also a wrapper around the `ray.tune.integration.pytorch_lightning.TuneReportCheckpointCallback` that will do checkpoint reporting with retries to handle transient s3 errors.
+This is provided at `lightray.callbacks.LightRayReportCheckpointCallback`
+
+
+## Remote cluster
+To connect to a remote ray cluster, pass the ip address (using port `10001`) to `ray_init.address`:
+
+```console
+lightray --config tune.yaml --ray_init.address ray://{ip}:10001 -- --config cli.yaml
+```

lightray-0.2.5/lightray.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+lightray/__init__.py
+lightray/callbacks.py
+lightray/cli.py
+lightray/fs.py
+lightray/utils.py
+lightray.egg-info/PKG-INFO
+lightray.egg-info/SOURCES.txt
+lightray.egg-info/dependency_links.txt
+lightray.egg-info/entry_points.txt
+lightray.egg-info/requires.txt
+lightray.egg-info/top_level.txt
+tests/test_cli.py

lightray-0.2.5/lightray.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

lightray-0.2.5/lightray.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+lightray = lightray.cli:cli

lightray-0.2.5/lightray.egg-info/requires.txt

@@ -0,0 +1,7 @@
+ray[default,tune]<3,>=2.41
+lightning>=2.4.0
+s3fs>=2024.9.0
+pyarrow>=17
+jsonargparse[signatures]<5,>=4.50
+omegaconf<3,>=2.3.0
+botocore

lightray-0.2.5/lightray.egg-info/top_level.txt

@@ -0,0 +1 @@
+lightray

lightray-0.2.5/pyproject.toml

@@ -0,0 +1,57 @@
+[project]
+name = "lightray"
+dynamic = ["version"]
+description = "Distribute a LightningCLI hyperparameter search with Ray Tune"
+authors = [{ name = "Ethan Jacob Marx", email = "ethan.marx@ligo.org" }]
+maintainers = [{ name = "Will Benoit", email = "william.benoit@ligo.org" }]
+requires-python = ">=3.11,<3.15"
+readme = "README.md"
+license = "MIT"
+dependencies = [
+    "ray[default, tune]>=2.41,<3",
+    "lightning>=2.4.0",
+    "s3fs>=2024.9.0",
+    "pyarrow>=17",
+    "jsonargparse[signatures]>=4.50,<5",
+    "omegaconf>=2.3.0,<3",
+    "botocore",
+]
+
+[project.urls]
+Repository = "https://github.com/ML4GW/lightray"
+
+[project.scripts]
+lightray = "lightray.cli:cli"
+
+[dependency-groups]
+dev = [
+    "pre-commit>=3.8.0,<4",
+    "pytest>=8.3.2,<9",
+]
+
+[tool.setuptools.packages.find]
+include = ["lightray*"]
+
+[tool.setuptools-git-versioning]
+enabled = true
+# skip the helm chart release tags (ray-cluster-*)
+tag_filter = "v.*"
+dev_template = "{tag}.post{ccount}+git.{sha}"
+
+[build-system]
+requires = [ "setuptools>=77.0.3", "wheel", "setuptools-git-versioning>=2.0,<4",]
+build-backend = "setuptools.build_meta"
+
+[tool.ruff]
+line-length = 79
+extend-exclude = ["docs"]
+
+
+[tool.ruff.lint]
+mccabe = {"max-complexity" = 18}
+select = ["B", "C", "E", "F", "W", "B9", "T201"]
+ignore = ["W605", "E203"]  # ignore for consistency with black
+
+# ignore asterisk imports and unused
+# import errors in __init__ files
+per-file-ignores =  {"**/__init__.py" = ["F401", "F403"]}

lightray-0.2.5/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

lightray-0.2.5/tests/test_cli.py

@@ -0,0 +1,2 @@
+def test():
+    assert True

lightray-0.2.3/pyproject.toml

@@ -1,47 +0,0 @@
-[tool.poetry]
-name = "lightray"
-version = "0.2.3"
-description = "Distribute a LightningCLI hyperparameter search with Ray Tune"
-authors = ["Ethan Jacob Marx <ethan.marx@ligo.org>"]
-license = "MIT"
-readme = "README.md"
-
-[tool.poetry.dependencies]
-python = "^3.9"
-ray = {version = "^2.8.0", extras = ["default", "tune"]}
-lightning = "<=2.4.0"
-s3fs = {version = "^2024.9.0"}
-pyarrow = {version = "^17.0.0"}
-jsonargparse = {version = "^4.33.2", extras = ["signatures"]}
-wandb = "^0.18.5"
-omegaconf = "^2.3.0"
-
-
-[tool.poetry.scripts]
-lightray = "lightray.cli:cli"
-
-[tool.poetry.group.dev.dependencies]
-pre-commit = "^3.8.0"
-pytest = "^8.3.2"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.black]
-line-length = 79
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.git
-  | \.tox
-  | _build
-  | dist
-  | docs
-)/
-'''
-
-
-[tool.isort]
-multi_line_output = 3
-include_trailing_comma = true