From d5c41b8f088964ba6cd3ba779f244a975057ede7 Mon Sep 17 00:00:00 2001 From: Tristan Spaulding <47005026+tristan-spaulding2@users.noreply.github.com> Date: Thu, 11 Jan 2024 16:23:48 -0500 Subject: [PATCH 1/2] fixed typo and deleted global cpu reference --- docs/guides/launch/launch-faqs.md | 12 +----------- docs/guides/launch/launch-queue-observability.md | 2 +- 2 files changed, 2 insertions(+), 12 deletions(-) diff --git a/docs/guides/launch/launch-faqs.md b/docs/guides/launch/launch-faqs.md index 23dbafe20..f89d8ee06 100644 --- a/docs/guides/launch/launch-faqs.md +++ b/docs/guides/launch/launch-faqs.md @@ -171,17 +171,7 @@ Yes. The suggested way is: 1. Add the secret as a vanilla k8s secret in the namespace where the runs will be created. something likeĀ `kubectl create secret -n generic ` - 2. Once that secret is created, you can specify a queue config to inject the secret when runs start. The end users cannot see the secret, only cluster admins can. An example is done in the `W&B Global CPU` queue:[https://wandb.ai/wandb/launch/UnVuUXVldWU6MTcxODMwOA==/config](https://wandb.ai/wandb/launch/UnVuUXVldWU6MTcxODMwOA==/config) . Specifically: - -```yaml -env: - - name: OPENAI_API_KEY - valueFrom: - secretKeyRef: - key: password - name: openai-api-key - -``` + 2. Once that secret is created, you can specify a queue config to inject the secret when runs start. The end users cannot see the secret, only cluster admins can. ### How can admins restrict what ML engineers have access to modify? For example, changing an image tag may be fine but other job settings may not be. diff --git a/docs/guides/launch/launch-queue-observability.md b/docs/guides/launch/launch-queue-observability.md index 830ebdee7..10e82cc7f 100644 --- a/docs/guides/launch/launch-queue-observability.md +++ b/docs/guides/launch/launch-queue-observability.md @@ -2,7 +2,7 @@ displayed_sidebar: default --- -# Queue monitoting dashboard (beta) +# Queue monitoring dashboard (beta) Use the interactive **Queue monitoring dashboard** to view when a launch queue is in heavy use or idle, visualize workloads that are running, and spot inefficient jobs. The launch queue dashboard is especially useful for deciding whether or not you are effectively using your compute hardware or cloud resources. From 5b2d95f289cbdb7b68bfc22b264a25d86c3ce6fa Mon Sep 17 00:00:00 2001 From: Tristan Spaulding <47005026+tristan-spaulding2@users.noreply.github.com> Date: Thu, 11 Jan 2024 16:27:09 -0500 Subject: [PATCH 2/2] added colab link correctly --- docs/guides/launch/create-launch-job.md | 5 +++++ docs/guides/launch/walkthrough.md | 1 + 2 files changed, 6 insertions(+) diff --git a/docs/guides/launch/create-launch-job.md b/docs/guides/launch/create-launch-job.md index 2826c4fa5..ca63039bf 100644 --- a/docs/guides/launch/create-launch-job.md +++ b/docs/guides/launch/create-launch-job.md @@ -3,9 +3,12 @@ displayed_sidebar: default --- import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; +import { CTAButtons } from '@site/src/components/CTAButtons/CTAButtons.tsx'; + # Create a launch job + A job is a blueprint that contains contextual information about a W&B run it is created from; such as the run's source code, software dependencies, hyperparameters, artifact version, and so forth. Once you have a launch job, you can add them to a pre-configured [launch queue](./launch-terminology.md#launch-queue). The launch agent that was deployed by you or someone on your team, will poll that queue and send the job (as a Docker image) to the compute resource that was configured on launch queue. @@ -17,6 +20,8 @@ There are three ways to create a launch job: * With a Docker image * With Git repository + + The following sections show how to create a job based on each use case. diff --git a/docs/guides/launch/walkthrough.md b/docs/guides/launch/walkthrough.md index 56bdd1dc8..4c00bf94f 100644 --- a/docs/guides/launch/walkthrough.md +++ b/docs/guides/launch/walkthrough.md @@ -2,6 +2,7 @@ description: Getting started guide for W&B Launch. displayed_sidebar: default --- +import { CTAButtons } from '@site/src/components/CTAButtons/CTAButtons.tsx'; # Walkthrough