Skip to content

Commit

Permalink
[Jobs] Hide dashboard from Job Submission import path (ray-project#…
Browse files Browse the repository at this point in the history
…22223)

For public SDK APIs, change the import path from 

```python
from ray.dashboard.modules.job.common import JobStatus, JobStatusInfo
from ray.dashboard.modules.job.sdk import JobSubmissionClient
```

to 
```python
from ray.job_submission import JobStatus, JobSubmissionClient
```

`JobStatus`, `JobStatusInfo` and `JobSubmissionClient` were the only names referenced in the SDK doc so far, but we can add more later as they appear.
  • Loading branch information
architkulkarni authored Feb 9, 2022
1 parent 293e45c commit 50e2bef
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 11 deletions.
3 changes: 1 addition & 2 deletions dashboard/modules/job/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@
import click

from ray.autoscaler._private.cli_logger import add_click_logging_options, cli_logger, cf
from ray.dashboard.modules.job.common import JobStatus
from ray.dashboard.modules.job.sdk import JobSubmissionClient
from ray.job_submission import JobStatus, JobSubmissionClient


def _get_sdk_client(
Expand Down
3 changes: 1 addition & 2 deletions dashboard/modules/job/job_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,8 @@
from ray.exceptions import RuntimeEnvSetupError
import ray.ray_constants as ray_constants
from ray.actor import ActorHandle
from ray.job_submission import JobStatus, JobStatusInfo
from ray.dashboard.modules.job.common import (
JobStatus,
JobStatusInfo,
JobStatusStorageClient,
JOB_ID_METADATA_KEY,
JOB_NAME_METADATA_KEY,
Expand Down
4 changes: 2 additions & 2 deletions dashboard/modules/job/tests/test_http_job_server.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
from unittest.mock import patch

import ray
from ray.dashboard.modules.job.common import CURRENT_VERSION, JobStatus
from ray.job_submission import JobSubmissionClient, JobStatus
from ray.dashboard.modules.job.common import CURRENT_VERSION
from ray.dashboard.modules.job.sdk import (
ClusterInfo,
JobSubmissionClient,
parse_cluster_info,
)
from ray.dashboard.tests.conftest import * # noqa
Expand Down
2 changes: 1 addition & 1 deletion dashboard/modules/job/tests/test_job_manager.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@
import pytest

import ray
from ray.job_submission import JobStatus
from ray.dashboard.modules.job.common import (
JobStatus,
JOB_ID_METADATA_KEY,
JOB_NAME_METADATA_KEY,
)
Expand Down
2 changes: 1 addition & 1 deletion dashboard/modules/snapshot/snapshot_head.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@
import ray.dashboard.utils as dashboard_utils
import ray.dashboard.optional_utils as dashboard_optional_utils
from ray._private.runtime_env.validation import ParsedRuntimeEnv
from ray.job_submission import JobStatusInfo
from ray.dashboard.modules.job.common import (
JobStatusInfo,
JobStatusStorageClient,
JOB_ID_METADATA_KEY,
)
Expand Down
2 changes: 1 addition & 1 deletion dashboard/modules/snapshot/tests/test_job_submission.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
)
from ray.dashboard import dashboard
from ray.dashboard.tests.conftest import * # noqa
from ray.dashboard.modules.job.sdk import JobSubmissionClient
from ray.job_submission import JobSubmissionClient

logger = logging.getLogger(__name__)

Expand Down
4 changes: 2 additions & 2 deletions doc/source/cluster/job-submission.rst
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ We can import and initialize the Job submission client by providing a valid Ray

.. code-block:: python
from ray.dashboard.modules.job.sdk import JobSubmissionClient
from ray.job_submission import JobSubmissionClient
client = JobSubmissionClient("http://127.0.0.1:8265")
Expand All @@ -169,7 +169,7 @@ Now we can have a simple polling loop that checks the job status until it reache

.. code-block:: python
from ray.dashboard.modules.job.common import JobStatus, JobStatusInfo
from ray.job_submission import JobStatus
def wait_until_finish(job_id):
start = time.time()
Expand Down
4 changes: 4 additions & 0 deletions python/ray/job_submission/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
from ray.dashboard.modules.job.sdk import JobSubmissionClient
from ray.dashboard.modules.job.common import JobStatus, JobStatusInfo

__all__ = ["JobSubmissionClient", "JobStatus", "JobStatusInfo"]

0 comments on commit 50e2bef

Please sign in to comment.