Skip to content

Commit 1df81a8

Browse files
authored
chore(security): update examples for API keys (#616)
1 parent e93ad9b commit 1df81a8

13 files changed

Lines changed: 24 additions & 25 deletions

colabs/huggingface/Custom_Progress_Callback.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@
7373
"\n",
7474
"## 🔑 Put in your API key\n",
7575
"\n",
76-
"Once you've signed up, run the next cell and click on the link to get your API key and authenticate this notebook."
76+
"Once you've signed up, run the next cell. You'll be prompted to create a new API key at [wandb.ai/settings](https://wandb.ai/settings) if you haven't already. Store your API key securely. It can only be viewed once when created."
7777
]
7878
},
7979
{

colabs/huggingface/Huggingface_wandb.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@
116116
"metadata": {},
117117
"source": [
118118
"## 🔑 Put in your API key\n",
119-
"Once you've signed up, run the next cell and click on the link to get your API key and authenticate this notebook."
119+
"Once you've signed up, run the next cell. You'll be prompted to create a new API key at [wandb.ai/settings](https://wandb.ai/settings) if you haven't already. Store your API key securely. It can only be viewed once when created."
120120
]
121121
},
122122
{

colabs/huggingface/wandb_hf_example.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,10 +76,10 @@
7676
"source": [
7777
"\n",
7878
"## 🖊️ Sign-up/login\n",
79-
"If this is your first time using Weights & Baises or you are not logged in, the link that appears after running `wandb.login()` in the following code cell will take you to sign-up/login page. Signing up for a [free account](https://wandb.ai/signup) is as easy as a few clicks. \n",
79+
"If this is your first time using Weights & Biases or you are not logged in, the link that appears after running `wandb.login()` in the following code cell will take you to sign-up/login page. Signing up for a [free account](https://wandb.ai/signup) is as easy as a few clicks. \n",
8080
"\n",
8181
"## 🔑 Authentication\n",
82-
"Once you've signed up, run the next cell and click on the link to get your API key and authenticate this notebook."
82+
"Once you've signed up, run the next cell. You'll be prompted to create a new API key at [wandb.ai/settings](https://wandb.ai/settings) if you haven't already. Store your API key securely. It can only be viewed once when created."
8383
]
8484
},
8585
{

colabs/mmdetection/Train_Object_Detector_with_MMDetection_and_W&B.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,9 +144,9 @@
144144
"cell_type": "markdown",
145145
"metadata": {},
146146
"source": [
147-
"### 4️⃣ Login with you W&B account\n",
147+
"### 4️⃣ Login with your W&B account\n",
148148
"\n",
149-
"Create a free W&B account (it's free for personal and academic usage). Visit wandb.ai/authorize to get your unique authentication token. "
149+
"Create a free W&B account (it's free for personal and academic usage). Create a new API key at [wandb.ai/settings](https://wandb.ai/settings) and store it securely. API keys can only be viewed once when created. "
150150
]
151151
},
152152
{

colabs/mmdetection/Train_an_Object_Detection+Semantic_Segmentation_Model_with_MMDetection_and_W&B.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,9 +142,9 @@
142142
"cell_type": "markdown",
143143
"metadata": {},
144144
"source": [
145-
"### 4️⃣ Login with you W&B account\n",
145+
"### 4️⃣ Login with your W&B account\n",
146146
"\n",
147-
"Create a free W&B account (it's free for personal and academic usage). Visit [wandb.ai/authorize](https://wandb.ai/authorize) to get your unique authentication token. "
147+
"Create a free W&B account (it's free for personal and academic usage). Create a new API key at [wandb.ai/settings](https://wandb.ai/settings) and store it securely. API keys can only be viewed once when created. "
148148
]
149149
},
150150
{

colabs/openai/OpenAI_API_Autologger_Quickstart.ipynb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@
5959
"source": [
6060
"### 🪄 2. Import and call `autolog`\n",
6161
"\n",
62-
"When you call `autolog` you will be prompted to login to Weights & Biases with your api key, which you can find at https://www.wandb.ai/authorize\n",
63-
"\n",
62+
"When you call `autolog` you will be prompted to login to Weights & Biases. If you haven't already, create a new API key at [wandb.ai/settings](https://wandb.ai/settings) and store it securely. API keys can only be viewed once when created.\n",
6463
"\n",
6564
"You can optionally pass a dictionary with arguments for [wandb.init()](https://docs.wandb.ai/ref/python/init) such as a project name, team name, entity, and more. For more information about wandb.init, see the [API Reference Guide](https://docs.wandb.ai/ref/python/init)."
6665
]

colabs/prompts/W&B_Prompts_with_Custom_Columns.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@
169169
"source": [
170170
"Use LangChain as normal by calling your Agent.\n",
171171
"\n",
172-
" You will see a Weights & Biases run start and you will be asked for your [Weights & Biases API key](wwww.wandb.ai/authorize). Once your enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App."
172+
"You will see a Weights & Biases run start and you will be prompted to create a new API key at [wandb.ai/settings](https://wandb.ai/settings) if you haven't already. Store your API key securely. It can only be viewed once when created. Once you enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App."
173173
]
174174
},
175175
{
@@ -266,7 +266,7 @@
266266
"source": [
267267
"Call wandb.init to start a W&B run. Here you can pass a W&B project name as well as an entity name (if logging to a W&B Team), as well as a config and more. See wandb.init for the full list of arguments.\n",
268268
"\n",
269-
"You will see a Weights & Biases run start and be asked for your [Weights & Biases API key](wwww.wandb.ai/authorize). Once your enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App.\n",
269+
"You will see a Weights & Biases run start and be prompted to create a new API key at [wandb.ai/settings](https://wandb.ai/settings) if you haven't already. Store your API key securely. It can only be viewed once when created. Once you enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App.\n",
270270
"\n",
271271
"**Note:** A W&B run supports logging as many traces you needed to a single run, i.e. you can make multiple calls of `run.log` without the need to create a new run each time"
272272
]

colabs/prompts/WandB_LLM_QA_bot.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@
101101
"## Log in to W&B\n",
102102
"- You can explicitly login using `wandb login` or `wandb.login()` (See below)\n",
103103
"- Alternatively you can set environment variables. There are several env variables which you can set to change the behavior of W&B logging. The most important are:\n",
104-
" - `WANDB_API_KEY` - find this in your \"Settings\" section under your profile\n",
104+
" - `WANDB_API_KEY` - create a new API key in your \"Settings\" section under your profile at [wandb.ai/settings](https://wandb.ai/settings)\n",
105105
" - `WANDB_BASE_URL` - this is the url of the W&B server (You only need this if you are using a private instance)\n",
106-
"- Find your API Token in \"Profile\" -> \"Setttings\" in the W&B App\n",
106+
"- Create a new API key in \"Profile\" -> \"Settings\" in the W&B App. Store your API key securely. It can only be viewed once when created.\n",
107107
"\n",
108108
"![api_token](https://drive.google.com/uc?export=view&id=1Xn7hnn0rfPu_EW0A_-32oCXqDmpA0-kx)"
109109
]

colabs/prompts/WandB_Prompts_Quickstart.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@
179179
"source": [
180180
"Use LangChain as normal by calling your Agent.\n",
181181
"\n",
182-
" You will see a Weights & Biases run start and you will be asked for your [Weights & Biases API key](wwww.wandb.ai/authorize). Once your enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App."
182+
"You will see a Weights & Biases run start and you will be prompted to create a new API key at [wandb.ai/settings](https://wandb.ai/settings) if you haven't already. Store your API key securely. It can only be viewed once when created. Once you enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App."
183183
]
184184
},
185185
{
@@ -266,7 +266,7 @@
266266
"source": [
267267
"Call wandb.init to start a W&B run. Here you can pass a W&B project name as well as an entity name (if logging to a W&B Team), as well as a config and more. See wandb.init for the full list of arguments.\n",
268268
"\n",
269-
"You will see a Weights & Biases run start and be asked for your [Weights & Biases API key](wwww.wandb.ai/authorize). Once your enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App.\n",
269+
"You will see a Weights & Biases run start and be prompted to create a new API key at [wandb.ai/settings](https://wandb.ai/settings) if you haven't already. Store your API key securely. It can only be viewed once when created. Once you enter your API key, the inputs and outputs of your Agent calls will start to be streamed to the Weights & Biases App.\n",
270270
"\n",
271271
"**Note:** A W&B run supports logging as many traces you needed to a single run, i.e. you can make multiple calls of `run.log` without the need to create a new run each time"
272272
]

colabs/tensorboard/TensorBoard_and_Weights_and_Biases.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939
"\n",
4040
"1️⃣. Sign-up for a free W&B [account here](https://wandb.ai/site)\n",
4141
"\n",
42-
"2️⃣. Get your W&B [API key here](https://wandb.ai/authorize)\n",
42+
"2️⃣. Create a new W&B [API key at your settings page](https://wandb.ai/settings) and store it securely. API keys can only be viewed once when created.\n",
4343
"\n",
44-
"3️⃣. Initialise a W&B run with wandb.init and pass in your API key to log in"
44+
"3️⃣. Initialise a W&B run with wandb.init and you will be prompted to enter your API key to log in"
4545
]
4646
},
4747
{

0 commit comments

Comments
 (0)