From 39e59e1d79d3be3dac8b9227acc56f082459a69c Mon Sep 17 00:00:00 2001 From: Noah Luna <15202580+ngrayluna@users.noreply.github.com> Date: Mon, 23 Jun 2025 15:19:51 -0700 Subject: [PATCH] remove launch apis --- content/en/ref/python/public-api/_index.md | 6 --- content/en/ref/python/public-api/job.md | 39 --------------- content/en/ref/python/public-api/queuedrun.md | 47 ------------------ content/en/ref/python/public-api/runqueue.md | 49 ------------------- static/_redirects | 3 ++ 5 files changed, 3 insertions(+), 141 deletions(-) delete mode 100644 content/en/ref/python/public-api/job.md delete mode 100644 content/en/ref/python/public-api/queuedrun.md delete mode 100644 content/en/ref/python/public-api/runqueue.md diff --git a/content/en/ref/python/public-api/_index.md b/content/en/ref/python/public-api/_index.md index 65a50d7f6..e0acf0c72 100644 --- a/content/en/ref/python/public-api/_index.md +++ b/content/en/ref/python/public-api/_index.md @@ -14,20 +14,14 @@ title: Import & Export API [`class Files`](./files.md): An iterable collection of `File` objects. -[`class Job`](./job.md) - [`class Project`](./project.md): A project is a namespace for runs. [`class Projects`](./projects.md): An iterable collection of `Project` objects. -[`class QueuedRun`](./queuedrun.md): A single queued run associated with an entity and project. Call `run = queued_run.wait_until_running()` or `run = queued_run.wait_until_finished()` to access the run. - [`class Registry`](./registry.md): A single registry in the Registry. [`class Run`](./run.md): A single run associated with an entity and project. -[`class RunQueue`](./runqueue.md) - [`class Runs`](./runs.md): An iterable collection of runs associated with a project and optional filter. [`class Sweep`](./sweep.md): A set of runs associated with a sweep. diff --git a/content/en/ref/python/public-api/job.md b/content/en/ref/python/public-api/job.md deleted file mode 100644 index a7a8b18fd..000000000 --- a/content/en/ref/python/public-api/job.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Job ---- - -{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L30-L211 >}} - -```python -Job( - api: "Api", - name, - path: Optional[str] = None -) -> None -``` - -| Attributes | | -| :--- | :--- | - -## Methods - -### `call` - -[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L167-L211) - -```python -call( - config, project=None, entity=None, queue=None, resource="local-container", - resource_args=None, template_variables=None, project_queue=None, priority=None -) -``` - -### `set_entrypoint` - -[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L164-L165) - -```python -set_entrypoint( - entrypoint: List[str] -) -``` diff --git a/content/en/ref/python/public-api/queuedrun.md b/content/en/ref/python/public-api/queuedrun.md deleted file mode 100644 index 53fdcc61d..000000000 --- a/content/en/ref/python/public-api/queuedrun.md +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: QueuedRun ---- - -{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L214-L418 >}} - -A single queued run associated with an entity and project. Call `run = queued_run.wait_until_running()` or `run = queued_run.wait_until_finished()` to access the run. - -```python -QueuedRun( - client, entity, project, queue_name, run_queue_item_id, - project_queue=LAUNCH_DEFAULT_PROJECT, priority=None -) -``` - -| Attributes | | -| :--- | :--- | - -## Methods - -### `delete` - -[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L338-L387) - -```python -delete( - delete_artifacts=(False) -) -``` - -Delete the given queued run from the wandb backend. - -### `wait_until_finished` - -[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L328-L336) - -```python -wait_until_finished() -``` - -### `wait_until_running` - -[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L389-L415) - -```python -wait_until_running() -``` diff --git a/content/en/ref/python/public-api/runqueue.md b/content/en/ref/python/public-api/runqueue.md deleted file mode 100644 index 3bd692d1a..000000000 --- a/content/en/ref/python/public-api/runqueue.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: RunQueue ---- - -{{< cta-button githubLink=https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L428-L654 >}} - -```python -RunQueue( - client: "RetryingClient", - name: str, - entity: str, - prioritization_mode: Optional[RunQueuePrioritizationMode] = None, - _access: Optional[RunQueueAccessType] = None, - _default_resource_config_id: Optional[int] = None, - _default_resource_config: Optional[dict] = None -) -> None -``` - -| Attributes | | -| :--- | :--- | -| `items` | Up to the first 100 queued runs. Modifying this list will not modify the queue or any enqueued items! | - -## Methods - -### `create` - -[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L641-L654) - -```python -@classmethod -create( - name: str, - resource: "RunQueueResourceType", - entity: Optional[str] = None, - prioritization_mode: Optional['RunQueuePrioritizationMode'] = None, - config: Optional[dict] = None, - template_variables: Optional[dict] = None -) -> "RunQueue" -``` - -### `delete` - -[View source](https://www.github.com/wandb/wandb/tree/v0.20.1/wandb/apis/public/jobs.py#L515-L537) - -```python -delete() -``` - -Delete the run queue from the wandb backend. diff --git a/static/_redirects b/static/_redirects index 43875453e..d0c6f1e44 100644 --- a/static/_redirects +++ b/static/_redirects @@ -360,6 +360,9 @@ /ref/python/inittorch.view_as_real/ /ref/python/init/ 301 /ref/python/integrations/sklearn/ /guides/integrations/scikit/ 301 /ref/python/join/ /ref/python/ 301 +/ref/python/public-api/queuedrun/ /ref/python/init/ 301 +/ref/python/public-api/runqueue/ /ref/python/init/ 301 +/ref/python/public-api/job/ /ref/python/init/ 301 /ref/python/README/ /ref/python/ 301 /ref/python/wandb.ai/settings/ /ref/python/ 301 /ref/README/ /ref/ 301