anyscale 0.26.16__py3-none-any.whl → 0.26.18__py3-none-any.whl

anyscale/client/openapi_client/models/job_with_report.py

@@ -0,0 +1,254 @@
+# coding: utf-8
+
+"""
+    Managed Ray API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)  # noqa: E501
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from openapi_client.configuration import Configuration
+
+
+class JobWithReport(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+        'job_id': 'str',
+        'job_name': 'str',
+        'job_state': 'HaJobStates',
+        'job_report': 'JobReport',
+        'created_at': 'datetime',
+        'finished_at': 'datetime'
+    }
+
+    attribute_map = {
+        'job_id': 'job_id',
+        'job_name': 'job_name',
+        'job_state': 'job_state',
+        'job_report': 'job_report',
+        'created_at': 'created_at',
+        'finished_at': 'finished_at'
+    }
+
+    def __init__(self, job_id=None, job_name=None, job_state=None, job_report=None, created_at=None, finished_at=None, local_vars_configuration=None):  # noqa: E501
+        """JobWithReport - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+
+        self._job_id = None
+        self._job_name = None
+        self._job_state = None
+        self._job_report = None
+        self._created_at = None
+        self._finished_at = None
+        self.discriminator = None
+
+        self.job_id = job_id
+        self.job_name = job_name
+        self.job_state = job_state
+        if job_report is not None:
+            self.job_report = job_report
+        self.created_at = created_at
+        if finished_at is not None:
+            self.finished_at = finished_at
+
+    @property
+    def job_id(self):
+        """Gets the job_id of this JobWithReport.  # noqa: E501
+
+
+        :return: The job_id of this JobWithReport.  # noqa: E501
+        :rtype: str
+        """
+        return self._job_id
+
+    @job_id.setter
+    def job_id(self, job_id):
+        """Sets the job_id of this JobWithReport.
+
+
+        :param job_id: The job_id of this JobWithReport.  # noqa: E501
+        :type: str
+        """
+        if self.local_vars_configuration.client_side_validation and job_id is None:  # noqa: E501
+            raise ValueError("Invalid value for `job_id`, must not be `None`")  # noqa: E501
+
+        self._job_id = job_id
+
+    @property
+    def job_name(self):
+        """Gets the job_name of this JobWithReport.  # noqa: E501
+
+
+        :return: The job_name of this JobWithReport.  # noqa: E501
+        :rtype: str
+        """
+        return self._job_name
+
+    @job_name.setter
+    def job_name(self, job_name):
+        """Sets the job_name of this JobWithReport.
+
+
+        :param job_name: The job_name of this JobWithReport.  # noqa: E501
+        :type: str
+        """
+        if self.local_vars_configuration.client_side_validation and job_name is None:  # noqa: E501
+            raise ValueError("Invalid value for `job_name`, must not be `None`")  # noqa: E501
+
+        self._job_name = job_name
+
+    @property
+    def job_state(self):
+        """Gets the job_state of this JobWithReport.  # noqa: E501
+
+
+        :return: The job_state of this JobWithReport.  # noqa: E501
+        :rtype: HaJobStates
+        """
+        return self._job_state
+
+    @job_state.setter
+    def job_state(self, job_state):
+        """Sets the job_state of this JobWithReport.
+
+
+        :param job_state: The job_state of this JobWithReport.  # noqa: E501
+        :type: HaJobStates
+        """
+        if self.local_vars_configuration.client_side_validation and job_state is None:  # noqa: E501
+            raise ValueError("Invalid value for `job_state`, must not be `None`")  # noqa: E501
+
+        self._job_state = job_state
+
+    @property
+    def job_report(self):
+        """Gets the job_report of this JobWithReport.  # noqa: E501
+
+
+        :return: The job_report of this JobWithReport.  # noqa: E501
+        :rtype: JobReport
+        """
+        return self._job_report
+
+    @job_report.setter
+    def job_report(self, job_report):
+        """Sets the job_report of this JobWithReport.
+
+
+        :param job_report: The job_report of this JobWithReport.  # noqa: E501
+        :type: JobReport
+        """
+
+        self._job_report = job_report
+
+    @property
+    def created_at(self):
+        """Gets the created_at of this JobWithReport.  # noqa: E501
+
+
+        :return: The created_at of this JobWithReport.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._created_at
+
+    @created_at.setter
+    def created_at(self, created_at):
+        """Sets the created_at of this JobWithReport.
+
+
+        :param created_at: The created_at of this JobWithReport.  # noqa: E501
+        :type: datetime
+        """
+        if self.local_vars_configuration.client_side_validation and created_at is None:  # noqa: E501
+            raise ValueError("Invalid value for `created_at`, must not be `None`")  # noqa: E501
+
+        self._created_at = created_at
+
+    @property
+    def finished_at(self):
+        """Gets the finished_at of this JobWithReport.  # noqa: E501
+
+
+        :return: The finished_at of this JobWithReport.  # noqa: E501
+        :rtype: datetime
+        """
+        return self._finished_at
+
+    @finished_at.setter
+    def finished_at(self, finished_at):
+        """Sets the finished_at of this JobWithReport.
+
+
+        :param finished_at: The finished_at of this JobWithReport.  # noqa: E501
+        :type: datetime
+        """
+
+        self._finished_at = finished_at
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, JobWithReport):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, JobWithReport):
+            return True
+
+        return self.to_dict() != other.to_dict()

anyscale/client/openapi_client/models/{webterminal_list_response.py → jobwithreport_list_response.py}

@@ -18,7 +18,7 @@ import six
 from openapi_client.configuration import Configuration
 
 
-class WebterminalListResponse(object):
+class JobwithreportListResponse(object):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -33,7 +33,7 @@ class WebterminalListResponse(object):
                             and the value is json key in definition.
     """
     openapi_types = {
-        'results': 'list[WebTerminal]',
+        'results': 'list[JobWithReport]',
         'metadata': 'ListResponseMetadata'
     }
 
@@ -43,7 +43,7 @@ class WebterminalListResponse(object):
     }
 
     def __init__(self, results=None, metadata=None, local_vars_configuration=None):  # noqa: E501
-        """WebterminalListResponse - a model defined in OpenAPI"""  # noqa: E501
+        """JobwithreportListResponse - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
         self.local_vars_configuration = local_vars_configuration
@@ -58,21 +58,21 @@ class WebterminalListResponse(object):
 
     @property
     def results(self):
-        """Gets the results of this WebterminalListResponse.  # noqa: E501
+        """Gets the results of this JobwithreportListResponse.  # noqa: E501
 
 
-        :return: The results of this WebterminalListResponse.  # noqa: E501
-        :rtype: list[WebTerminal]
+        :return: The results of this JobwithreportListResponse.  # noqa: E501
+        :rtype: list[JobWithReport]
         """
         return self._results
 
     @results.setter
     def results(self, results):
-        """Sets the results of this WebterminalListResponse.
+        """Sets the results of this JobwithreportListResponse.
 
 
-        :param results: The results of this WebterminalListResponse.  # noqa: E501
-        :type: list[WebTerminal]
+        :param results: The results of this JobwithreportListResponse.  # noqa: E501
+        :type: list[JobWithReport]
         """
         if self.local_vars_configuration.client_side_validation and results is None:  # noqa: E501
             raise ValueError("Invalid value for `results`, must not be `None`")  # noqa: E501
@@ -81,20 +81,20 @@ class WebterminalListResponse(object):
 
     @property
     def metadata(self):
-        """Gets the metadata of this WebterminalListResponse.  # noqa: E501
+        """Gets the metadata of this JobwithreportListResponse.  # noqa: E501
 
 
-        :return: The metadata of this WebterminalListResponse.  # noqa: E501
+        :return: The metadata of this JobwithreportListResponse.  # noqa: E501
         :rtype: ListResponseMetadata
         """
         return self._metadata
 
     @metadata.setter
     def metadata(self, metadata):
-        """Sets the metadata of this WebterminalListResponse.
+        """Sets the metadata of this JobwithreportListResponse.
 
 
-        :param metadata: The metadata of this WebterminalListResponse.  # noqa: E501
+        :param metadata: The metadata of this JobwithreportListResponse.  # noqa: E501
         :type: ListResponseMetadata
         """
 
@@ -134,14 +134,14 @@ class WebterminalListResponse(object):
 
     def __eq__(self, other):
         """Returns true if both objects are equal"""
-        if not isinstance(other, WebterminalListResponse):
+        if not isinstance(other, JobwithreportListResponse):
             return False
 
         return self.to_dict() == other.to_dict()
 
     def __ne__(self, other):
         """Returns true if both objects are not equal"""
-        if not isinstance(other, WebterminalListResponse):
+        if not isinstance(other, JobwithreportListResponse):
             return True
 
         return self.to_dict() != other.to_dict()

anyscale/commands/cloud_commands.py

@@ -1166,3 +1166,74 @@ def get_default_cloud() -> None:
 
     except ValueError as e:
         log.error(f"Error retrieving default cloud: {e}")
+
+
+@cloud_cli.command(
+    name="jobs-report",
+    help=(
+        "Generate a report of the jobs created in the last 7 days in HTML format. "
+        "Shows unused CPU-hours, unused GPU-hours, and other data."
+    ),
+    cls=AnyscaleCommand,
+    hidden=True,
+)
+@click.option(
+    "--cloud-id",
+    help="ID of the cloud to generate a report on.",
+    type=str,
+    required=True,
+)
+@click.option(
+    "--csv",
+    help="Outputs the report in CSV format.",
+    type=bool,
+    required=False,
+    default=False,
+    is_flag=True,
+)
+@click.option(
+    "--out",
+    help="Output file name for the report. (Default jobs_report.html)",
+    type=str,
+    required=False,
+    default=None,
+)
+@click.option(
+    "--sort-by",
+    help=(
+        "Column to sort by. (Default created_at). "
+        "created_at: Job creation time. "
+        "gpu: Unused GPU hours. "
+        "cpu: Unused CPU hours. "
+        "instances: Number of instances."
+    ),
+    type=click.Choice(["created_at", "gpu", "cpu", "instances"], case_sensitive=False),
+    required=False,
+    default="created_at",
+)
+@click.option(
+    "--sort-order",
+    help="Sort order. (Default desc)",
+    type=click.Choice(["asc", "desc"], case_sensitive=False),
+    required=False,
+    default="desc",
+)
+def generate_jobs_report(
+    cloud_id: str, csv: bool, out: Optional[str], sort_by: str, sort_order: str
+) -> None:
+    """
+    Generate a report of the jobs created in the last 7 days in HTML format.
+    Shows unused CPU-hours, unused GPU-hours, and other data.
+    :param cloud_id: The ID of the cloud to generate a report on.
+    :param csv: Outputs the report in CSV format.
+    :param out: Output file name for the report.
+    """
+    if out is None:
+        out = "jobs_report.html" if not csv else "jobs_report.csv"
+
+    try:
+        CloudController().generate_jobs_report(
+            cloud_id, csv, out, sort_by, sort_order == "asc"
+        )
+    except ValueError as e:
+        log.error(f"Error generating jobs report: {e}")

anyscale/connect_utils/prepare_cluster.py

@@ -56,6 +56,7 @@ BUILD_STEPS = [
 # Default minutes for autosuspend.
 DEFAULT_AUTOSUSPEND_TIMEOUT = 120
 
+
 # Default docker images to use for connect clusters.
 def _get_base_image(image: str, ray_version: str, cpu_or_gpu: str) -> str:
     py_version = "".join(str(x) for x in sys.version_info[0:2])
@@ -557,34 +558,36 @@ class PrepareClusterBlock:
         """
         Get the default cluster env build based on the local python and ray versions.
         """
-        py_version = "".join(str(x) for x in sys.version_info[0:2])
-        if sys.version_info.major == 3 and sys.version_info.minor == 10:
-            py_version = "310"
-        if py_version not in ["36", "37", "38", "39", "310"]:
+        major, minor = sys.version_info[:2]
+        MIN_PY_VER = (3, 8)
+        MAX_PY_VER = (3, 12)
+
+        if not (MIN_PY_VER <= (major, minor) <= MAX_PY_VER):
             raise ValueError(
-                "No default cluster env for py{}. Please use a version of python between 3.6 and 3.8.".format(
-                    py_version
-                )
+                f"No default container image for python version {major}.{minor}."
+                f"Please use a Python version between {MIN_PY_VER[0]}.{MIN_PY_VER[1]} "
+                f"and {MAX_PY_VER[0]}.{MAX_PY_VER[1]}."
             )
+
         ray_version = self._ray.__version__
         if version.parse(ray_version) < version.parse(MINIMUM_RAY_VERSION):
             raise ValueError(
-                f"No default cluster env for Ray version {ray_version}. Please upgrade "
+                f"No default container image for Ray version {ray_version}. Please upgrade "
                 f"to a version >= {MINIMUM_RAY_VERSION}."
             )
         if "dev0" in ray_version:
             raise ValueError(
                 f"Your locally installed Ray version is {ray_version}. "
-                "There is no default cluster environments for nightly versions of Ray."
+                "There is no default container image for nightly versions of Ray."
             )
         try:
             build = self.api_client.get_default_cluster_env_build_api_v2_builds_default_py_version_ray_version_get(
-                f"py{py_version}", ray_version
+                f"py{major}{minor}", ray_version
             ).result
             return build
         except Exception:  # noqa: BLE001
             raise RuntimeError(
-                f"Failed to get default cluster env for Ray: {ray_version} on Python: py{py_version}"
+                f"Failed to get default container image for Ray: {ray_version} on Python: py{major}{minor}"
             )
 
     def _get_cluster_build(
@@ -815,14 +818,16 @@ class PrepareClusterBlock:
         return compute_template_id
 
     def _register_compute_template(
-        self, project_id: str, config_object: ComputeTemplateConfig
+        self, project_id: str, config_object: ComputeTemplateConfig  # noqa: ARG002
     ) -> str:
         """
-        Register compute template with a default name and return the compute template id."""
+        Register compute template with a default name and return the compute template id.
+        """
         created_template = self.api_client.create_compute_template_api_v2_compute_templates_post(
             create_compute_template=CreateComputeTemplate(
                 name=gen_valid_name("autogenerated-config"),
-                project_id=project_id,
+                # project ID is deprecated in compute config
+                project_id=None,
                 config=config_object,
                 anonymous=True,
             )

anyscale/controllers/cloud_controller.py

@@ -3,6 +3,7 @@ Fetches data required and formats output for `anyscale cloud` commands.
 """
 
 import copy
+from datetime import datetime, timedelta
 import json
 from os import getenv
 import pathlib
@@ -16,6 +17,7 @@ import boto3
 from botocore.exceptions import ClientError, NoCredentialsError
 import click
 from click import Abort, ClickException
+from rich.progress import Progress, track
 import yaml
 
 from anyscale import __version__ as anyscale_version
@@ -72,8 +74,12 @@ from anyscale.controllers.cloud_functional_verification_controller import (
     CloudFunctionalVerificationType,
 )
 from anyscale.formatters import clouds_formatter
+from anyscale.job._private.job_sdk import (
+    HA_JOB_STATE_TO_JOB_STATE,
+    TERMINAL_HA_JOB_STATES,
+)
 from anyscale.shared_anyscale_utils.aws import AwsRoleArn
-from anyscale.shared_anyscale_utils.conf import ANYSCALE_ENV
+from anyscale.shared_anyscale_utils.conf import ANYSCALE_ENV, ANYSCALE_HOST
 from anyscale.util import (  # pylint:disable=private-import
     _client,
     _get_aws_efs_mount_target_ip,
@@ -3643,3 +3649,160 @@ class CloudController(BaseController):
                 )
 
     ### End of edit cloud ###
+
+    def generate_jobs_report(
+        self, cloud_id: str, csv: bool, out_path: str, sort: str, sort_order_asc: bool
+    ) -> None:
+        end_time = datetime.now()
+        start_time = end_time - timedelta(days=7)
+
+        full_results = []
+        paging_token: Optional[str] = None
+        count_per_page = 20
+        curr_page_results = None
+        total_jobs: Optional[int] = None
+
+        with Progress() as progress:
+            download_task = progress.add_task("Downloading jobs...", total=None)
+
+            while curr_page_results is None or len(curr_page_results) == count_per_page:
+                response = self.api_client.list_job_reports_api_v2_job_reports_get(
+                    cloud_id,
+                    start_time=start_time,
+                    end_time=end_time,
+                    paging_token=paging_token,
+                    count=count_per_page,
+                )
+                curr_page_results = response.results
+                full_results.extend(curr_page_results)
+                paging_token = response.metadata.next_paging_token
+                total_jobs = response.metadata.total
+                progress.update(
+                    download_task, total=total_jobs, advance=len(curr_page_results)
+                )
+
+            progress.update(download_task, completed=total_jobs)
+
+        if not full_results:
+            self.log.info("No jobs found in the last 7 days.")
+            return
+
+        filtered_results = [
+            job
+            for job in full_results
+            if job.job_state in TERMINAL_HA_JOB_STATES and job.job_report is not None
+        ]
+        if sort == "created_at":
+            filtered_results.sort(
+                key=lambda x: x.created_at, reverse=not sort_order_asc
+            )
+        elif sort == "gpu":
+            filtered_results.sort(
+                key=lambda x: x.job_report.unused_gpu_hours or 0,
+                reverse=not sort_order_asc,
+            )
+        elif sort == "cpu":
+            filtered_results.sort(
+                key=lambda x: x.job_report.unused_cpu_hours or 0,
+                reverse=not sort_order_asc,
+            )
+        elif sort == "instances":
+            filtered_results.sort(
+                key=lambda x: x.job_report.max_instances_launched or 0,
+                reverse=not sort_order_asc,
+            )
+
+        with open(out_path, "w") as out_file:
+            if csv:
+                out_file.write(
+                    "Job ID,Job name,Job state,Created at,Finished at,Duration,Unused CPU hours,Unused GPU hours,Max concurrent instances\n"
+                )
+                for job in track(filtered_results, description="Generating report..."):
+                    job_state = HA_JOB_STATE_TO_JOB_STATE[job.job_state]
+                    if job.finished_at is not None:
+                        duration = str(job.finished_at - job.created_at)
+                        finished_at = str(job.finished_at)
+                    else:
+                        duration = ""
+                        finished_at = ""
+                    unused_cpu_hours = job.job_report.unused_cpu_hours or ""
+                    unused_gpu_hours = job.job_report.unused_gpu_hours or ""
+                    max_instances_launched = job.job_report.max_instances_launched or ""
+
+                    out_file.write(
+                        f'"{job.job_id}","{job.job_name}","{job_state}","{str(job.created_at)}","{finished_at}","{duration}","{unused_cpu_hours}","{unused_gpu_hours}","{max_instances_launched}"\n'
+                    )
+            else:
+                out_file.write(
+                    f"""
+<html>
+<head>
+<title>Jobs Report - {str(end_time)}</title>
+<style>
+    table {{
+        border: 1px solid black;
+        border-collapse: collapse;
+    }}
+    th, td {{
+        border: 1px solid black;
+        border-collapse: collapse;
+        padding: 8px;
+    }}
+</style>
+</head>
+<body>
+<h1>Job Report - {str(end_time)}</h1>
+<p>Total jobs reported (finished jobs): {len(filtered_results)}</p>
+<p>Total jobs in the last 7 days: {total_jobs}</p>
+<table>
+<thead>
+<tr>
+<th>Job ID</th>
+<th>Job name</th>
+<th>Job state</th>
+<th>Created at</th>
+<th>Finished at</th>
+<th>Duration</th>
+<th>Unused CPU hours</th>
+<th>Unused GPU hours</th>
+<th>Max concurrent instances</th>
+</tr>
+</thead>
+<tbody>
+"""
+                )
+
+                for job in track(filtered_results, description="Generating report..."):
+                    job_state = HA_JOB_STATE_TO_JOB_STATE[job.job_state]
+                    if job.finished_at is not None:
+                        duration = str(job.finished_at - job.created_at)
+                        finished_at = str(job.finished_at)
+                    else:
+                        duration = ""
+                        finished_at = ""
+                    unused_cpu_hours = job.job_report.unused_cpu_hours or ""
+                    unused_gpu_hours = job.job_report.unused_gpu_hours or ""
+                    max_instances_launched = job.job_report.max_instances_launched or ""
+
+                    out_file.write(
+                        f"""
+<tr>
+<td><a target="_blank" rel="noreferrer" href="{ANYSCALE_HOST}/jobs/{job.job_id}">{job.job_id}</a></td>
+<td>{job.job_name}</td>
+<td>{job_state}</td>
+<td>{str(job.created_at)}</td>
+<td>{finished_at}</td>
+<td>{duration}</td>
+<td>{unused_cpu_hours}</td>
+<td>{unused_gpu_hours}</td>
+<td>{max_instances_launched}</td>
+</tr>
+"""
+                    )
+
+                out_file.write(
+                    """
+</tbody>
+</table>
+"""
+                )