nextmv 0.31.0__py3-none-any.whl → 0.32.0__py3-none-any.whl

nextmv/__about__.py

@@ -1 +1 @@
-__version__ = "v0.31.0"
+__version__ = "v0.32.0"

nextmv/__init__.py

@@ -3,8 +3,6 @@
 from .__about__ import __version__
 from .base_model import BaseModel as BaseModel
 from .base_model import from_dict as from_dict
-from .input import DEFAULT_INPUT_JSON_FILE as DEFAULT_INPUT_JSON_FILE
-from .input import INPUTS_KEY as INPUTS_KEY
 from .input import DataFile as DataFile
 from .input import Input as Input
 from .input import InputFormat as InputFormat
@@ -31,13 +29,6 @@ from .model import ModelConfiguration as ModelConfiguration
 from .options import Option as Option
 from .options import Options as Options
 from .options import Parameter as Parameter
-from .output import ASSETS_KEY as ASSETS_KEY
-from .output import DEFAULT_OUTPUT_JSON_FILE as DEFAULT_OUTPUT_JSON_FILE
-from .output import LOGS_FILE as LOGS_FILE
-from .output import LOGS_KEY as LOGS_KEY
-from .output import OUTPUTS_KEY as OUTPUTS_KEY
-from .output import SOLUTIONS_KEY as SOLUTIONS_KEY
-from .output import STATISTICS_KEY as STATISTICS_KEY
 from .output import Asset as Asset
 from .output import DataPoint as DataPoint
 from .output import LocalOutputWriter as LocalOutputWriter
@@ -66,13 +57,17 @@ from .run import Format as Format
 from .run import FormatInput as FormatInput
 from .run import FormatOutput as FormatOutput
 from .run import Metadata as Metadata
+from .run import OptionsSummaryItem as OptionsSummaryItem
+from .run import Run as Run
 from .run import RunConfiguration as RunConfiguration
 from .run import RunInformation as RunInformation
+from .run import RunInfoStatistics as RunInfoStatistics
 from .run import RunLog as RunLog
 from .run import RunQueuing as RunQueuing
 from .run import RunResult as RunResult
 from .run import RunType as RunType
 from .run import RunTypeConfiguration as RunTypeConfiguration
+from .run import StatisticsIndicator as StatisticsIndicator
 from .run import TrackedRun as TrackedRun
 from .run import TrackedRunStatus as TrackedRunStatus
 from .run import run_duration as run_duration

nextmv/cloud/application.py

@@ -64,6 +64,7 @@ from nextmv.run import (
     Format,
     FormatInput,
     FormatOutput,
+    Run,
     RunConfiguration,
     RunInformation,
     RunLog,
@@ -289,7 +290,8 @@ class Application:
 
     def batch_experiment(self, batch_id: str) -> BatchExperiment:
         """
-        Get a batch experiment.
+        Get a batch experiment. This method also returns the runs of the batch
+        experiment under the `.runs` attribute.
 
         Parameters
         ----------
@@ -318,7 +320,17 @@ class Application:
             endpoint=f"{self.experiments_endpoint}/batch/{batch_id}",
         )
 
-        return BatchExperiment.from_dict(response.json())
+        exp = BatchExperiment.from_dict(response.json())
+
+        runs_response = self.client.request(
+            method="GET",
+            endpoint=f"{self.experiments_endpoint}/batch/{batch_id}/runs",
+        )
+
+        runs = [Run.from_dict(run) for run in runs_response.json().get("runs", [])]
+        exp.runs = runs
+
+        return exp
 
     def batch_experiment_metadata(self, batch_id: str) -> BatchExperimentMetadata:
         """
@@ -818,6 +830,28 @@ class Application:
 
         return [ManagedInput.from_dict(managed_input) for managed_input in response.json()]
 
+    def list_runs(self) -> list[Run]:
+        """
+        List all runs.
+
+        Returns
+        -------
+        list[Run]
+            List of runs.
+
+        Raises
+        ------
+        requests.HTTPError
+            If the response status code is not 2xx.
+        """
+
+        response = self.client.request(
+            method="GET",
+            endpoint=f"{self.endpoint}/runs",
+        )
+
+        return [Run.from_dict(run) for run in response.json().get("runs", [])]
+
     def list_scenario_tests(self) -> list[BatchExperimentMetadata]:
         """
         List all batch scenario tests. Scenario tests are based on the batch
@@ -2759,7 +2793,7 @@ class Application:
         Examples
         --------
         >>> from nextmv.cloud import Application
-        >>> from nextmv.cloud.run import TrackedRun
+        >>> from nextmv import TrackedRun
         >>> app = Application(id="app_123")
         >>> tracked_run = TrackedRun(input={"data": [...]}, output={"solution": [...]})
         >>> run_id = app.track_run(tracked_run)

nextmv/cloud/batch_experiment.py

@@ -21,6 +21,7 @@ from typing import Any, Optional
 
 from nextmv.base_model import BaseModel
 from nextmv.cloud.input_set import InputSet
+from nextmv.run import Run
 
 
 class ExperimentStatus(str, Enum):
@@ -191,7 +192,10 @@ class BatchExperiment(BatchExperimentInformation):
     instance_ids : list[str]
         List of instance IDs used for the experiment.
     grouped_distributional_summaries : list[dict[str, Any]], optional
-        Grouped distributional summaries of the batch experiment. Defaults to None.
+        Grouped distributional summaries of the batch experiment. Defaults to
+        None.
+    runs : list[Run], optional
+        List of runs in the batch experiment. Defaults to None.
     """
 
     input_set_id: str
@@ -200,6 +204,8 @@ class BatchExperiment(BatchExperimentInformation):
     """List of instance IDs used for the experiment."""
     grouped_distributional_summaries: Optional[list[dict[str, Any]]] = None
     """Grouped distributional summaries of the batch experiment."""
+    runs: Optional[list[Run]] = None
+    """List of runs in the batch experiment."""
 
 
 class BatchExperimentRun(BaseModel):

nextmv/default_app/README.md

@@ -4,6 +4,7 @@ This is the basic structure of a Nextmv application.
 
 ```text
 ├── app.yaml
+├── main.py
 ├── README.md
 ├── requirements.txt
 └── src
@@ -11,7 +12,21 @@ This is the basic structure of a Nextmv application.
 
 * `app.yaml`: App manifest, containing the configuration to run the app
   remotely on Nextmv Cloud.
+* `main.py`: Entry point for the app.
 * `README.md`: Description of the app.
 * `requirements.txt`: Python dependencies for the app.
-* `src/`: Source code for the app. The `main.py` file is the entry point for
-  the app.
+* `src/`: Source code for the app.
+
+A sample input file is also provided as `input.json`.
+
+1. Install packages.
+
+    ```bash
+    pip3 install -r requirements.txt
+    ```
+
+2. Run the app.
+
+    ```bash
+    cat input.json | python3 main.py
+    ```

nextmv/default_app/app.yaml

@@ -9,5 +9,4 @@ python:
 # (e.g.: configs/*.json) is supported.
 files:
   - src/
-
-entrypoint: src/main.py
+  - main.py

nextmv/default_app/input.json

@@ -0,0 +1,5 @@
+{
+  "name": "Patches",
+  "radius": 6378,
+  "distance": 147.6
+}

nextmv/default_app/main.py

@@ -0,0 +1,37 @@
+from src.visuals import create_visuals
+
+import nextmv
+
+# Read the input from stdin.
+input = nextmv.load()
+name = input.data["name"]
+
+options = nextmv.Options(
+    nextmv.Option("details", bool, True, "Print details to logs. Default true.", False),
+)
+
+##### Insert model here
+
+# Print logs that render in the run view in Nextmv Console.
+message = f"Hello, {name}"
+nextmv.log(message)
+
+if options.details:
+    detail = f"You are {input.data['distance']} million km from the sun"
+    nextmv.log(detail)
+
+assets = create_visuals(name, input.data["radius"], input.data["distance"])
+
+# Write output and statistics.
+output = nextmv.Output(
+    options=options,
+    solution={"message": message},
+    statistics=nextmv.Statistics(
+        result=nextmv.ResultStatistics(
+            value=1.23,
+            custom={"message": message},
+        ),
+    ),
+    assets=assets,
+)
+nextmv.write(output)

nextmv/input.py

@@ -21,12 +21,10 @@ Functions
 load
     Load input data using a specified loader.
 
-Constants
----------
+Attributes
+----------
 INPUTS_KEY : str
     Key used for identifying inputs in the run.
-DEFAULT_INPUT_JSON_FILE : str
-    Constant for the default input JSON file name.
 """
 
 import copy
@@ -47,10 +45,6 @@ INPUTS_KEY = "inputs"
 """
 Inputs key constant used for identifying inputs in the run.
 """
-DEFAULT_INPUT_JSON_FILE = "input.json"
-"""
-Constant for the default input JSON file name.
-"""
 
 
 class InputFormat(str, Enum):