Skip to content

Commit 0a60f86

Browse files
authored
docs: just some tutorial notebook tweaks and a docstring update (#150)
* update doctstring * notebook tweaks * generate colab notebooks
1 parent 3693c2f commit 0a60f86

9 files changed

Lines changed: 155 additions & 156 deletions

docs/colab_notebooks/1-the-basics.ipynb

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5-
"id": "56daa304",
5+
"id": "2e6331ad",
66
"metadata": {},
77
"source": [
88
"# 🎨 Data Designer Tutorial: The Basics\n",
@@ -14,7 +14,7 @@
1414
},
1515
{
1616
"cell_type": "markdown",
17-
"id": "8734a74a",
17+
"id": "af3aad47",
1818
"metadata": {},
1919
"source": [
2020
"### ⚡ Colab Setup\n",
@@ -25,7 +25,7 @@
2525
{
2626
"cell_type": "code",
2727
"execution_count": null,
28-
"id": "45510d11",
28+
"id": "4c39e2a5",
2929
"metadata": {},
3030
"outputs": [],
3131
"source": [
@@ -36,7 +36,7 @@
3636
{
3737
"cell_type": "code",
3838
"execution_count": null,
39-
"id": "4bad4940",
39+
"id": "d8652e5e",
4040
"metadata": {},
4141
"outputs": [],
4242
"source": [
@@ -53,7 +53,7 @@
5353
},
5454
{
5555
"cell_type": "markdown",
56-
"id": "0543d90e",
56+
"id": "c51e6323",
5757
"metadata": {},
5858
"source": [
5959
"### 📦 Import the essentials\n",
@@ -64,7 +64,7 @@
6464
{
6565
"cell_type": "code",
6666
"execution_count": null,
67-
"id": "90185344",
67+
"id": "2de6b279",
6868
"metadata": {},
6969
"outputs": [],
7070
"source": [
@@ -85,7 +85,7 @@
8585
},
8686
{
8787
"cell_type": "markdown",
88-
"id": "e6fcf82b",
88+
"id": "6a484a8d",
8989
"metadata": {},
9090
"source": [
9191
"### ⚙️ Initialize the Data Designer interface\n",
@@ -98,7 +98,7 @@
9898
{
9999
"cell_type": "code",
100100
"execution_count": null,
101-
"id": "8760c1ef",
101+
"id": "7554bd1a",
102102
"metadata": {},
103103
"outputs": [],
104104
"source": [
@@ -107,7 +107,7 @@
107107
},
108108
{
109109
"cell_type": "markdown",
110-
"id": "da9d9f06",
110+
"id": "dc1d9f84",
111111
"metadata": {},
112112
"source": [
113113
"### 🎛️ Define model configurations\n",
@@ -124,7 +124,7 @@
124124
{
125125
"cell_type": "code",
126126
"execution_count": null,
127-
"id": "03760d56",
127+
"id": "76d22674",
128128
"metadata": {},
129129
"outputs": [],
130130
"source": [
@@ -154,7 +154,7 @@
154154
},
155155
{
156156
"cell_type": "markdown",
157-
"id": "a968637c",
157+
"id": "187da050",
158158
"metadata": {},
159159
"source": [
160160
"### 🏗️ Initialize the Data Designer Config Builder\n",
@@ -169,7 +169,7 @@
169169
{
170170
"cell_type": "code",
171171
"execution_count": null,
172-
"id": "e5768870",
172+
"id": "977497d1",
173173
"metadata": {},
174174
"outputs": [],
175175
"source": [
@@ -178,7 +178,7 @@
178178
},
179179
{
180180
"cell_type": "markdown",
181-
"id": "d12c1559",
181+
"id": "92c51ea0",
182182
"metadata": {},
183183
"source": [
184184
"## 🎲 Getting started with sampler columns\n",
@@ -195,7 +195,7 @@
195195
{
196196
"cell_type": "code",
197197
"execution_count": null,
198-
"id": "3c47fbe6",
198+
"id": "68d7a4e6",
199199
"metadata": {},
200200
"outputs": [],
201201
"source": [
@@ -204,7 +204,7 @@
204204
},
205205
{
206206
"cell_type": "markdown",
207-
"id": "b47862c5",
207+
"id": "314c4719",
208208
"metadata": {},
209209
"source": [
210210
"Let's start designing our product review dataset by adding product category and subcategory columns.\n"
@@ -213,7 +213,7 @@
213213
{
214214
"cell_type": "code",
215215
"execution_count": null,
216-
"id": "6ff2257f",
216+
"id": "1bcad060",
217217
"metadata": {},
218218
"outputs": [],
219219
"source": [
@@ -294,7 +294,7 @@
294294
},
295295
{
296296
"cell_type": "markdown",
297-
"id": "a26f889e",
297+
"id": "aab7414d",
298298
"metadata": {},
299299
"source": [
300300
"Next, let's add samplers to generate data related to the customer and their review.\n"
@@ -303,7 +303,7 @@
303303
{
304304
"cell_type": "code",
305305
"execution_count": null,
306-
"id": "e603d4cc",
306+
"id": "f191f5bf",
307307
"metadata": {},
308308
"outputs": [],
309309
"source": [
@@ -340,7 +340,7 @@
340340
},
341341
{
342342
"cell_type": "markdown",
343-
"id": "cf5070af",
343+
"id": "5d893b3d",
344344
"metadata": {},
345345
"source": [
346346
"## 🦜 LLM-generated columns\n",
@@ -355,7 +355,7 @@
355355
{
356356
"cell_type": "code",
357357
"execution_count": null,
358-
"id": "775c6fa8",
358+
"id": "2abadac9",
359359
"metadata": {},
360360
"outputs": [],
361361
"source": [
@@ -391,7 +391,7 @@
391391
},
392392
{
393393
"cell_type": "markdown",
394-
"id": "25796666",
394+
"id": "2c9cb423",
395395
"metadata": {},
396396
"source": [
397397
"### 🔁 Iteration is key – preview the dataset!\n",
@@ -408,7 +408,7 @@
408408
{
409409
"cell_type": "code",
410410
"execution_count": null,
411-
"id": "ba90ee16",
411+
"id": "71e3a022",
412412
"metadata": {},
413413
"outputs": [],
414414
"source": [
@@ -418,7 +418,7 @@
418418
{
419419
"cell_type": "code",
420420
"execution_count": null,
421-
"id": "db9d6f8a",
421+
"id": "28f7913d",
422422
"metadata": {},
423423
"outputs": [],
424424
"source": [
@@ -429,7 +429,7 @@
429429
{
430430
"cell_type": "code",
431431
"execution_count": null,
432-
"id": "cb555bd5",
432+
"id": "6621c80f",
433433
"metadata": {},
434434
"outputs": [],
435435
"source": [
@@ -439,7 +439,7 @@
439439
},
440440
{
441441
"cell_type": "markdown",
442-
"id": "b35ee52b",
442+
"id": "2b451ded",
443443
"metadata": {},
444444
"source": [
445445
"### 📊 Analyze the generated data\n",
@@ -452,7 +452,7 @@
452452
{
453453
"cell_type": "code",
454454
"execution_count": null,
455-
"id": "0d15fb8d",
455+
"id": "0f7cb6cc",
456456
"metadata": {},
457457
"outputs": [],
458458
"source": [
@@ -462,7 +462,7 @@
462462
},
463463
{
464464
"cell_type": "markdown",
465-
"id": "4fefec9f",
465+
"id": "721b3c7d",
466466
"metadata": {},
467467
"source": [
468468
"### 🆙 Scale up!\n",
@@ -475,17 +475,17 @@
475475
{
476476
"cell_type": "code",
477477
"execution_count": null,
478-
"id": "395faa2c",
478+
"id": "1ad777d1",
479479
"metadata": {},
480480
"outputs": [],
481481
"source": [
482-
"results = data_designer.create(config_builder, num_records=10)"
482+
"results = data_designer.create(config_builder, num_records=10, dataset_name=\"tutorial-1\")"
483483
]
484484
},
485485
{
486486
"cell_type": "code",
487487
"execution_count": null,
488-
"id": "65dcd625",
488+
"id": "df089509",
489489
"metadata": {},
490490
"outputs": [],
491491
"source": [
@@ -498,7 +498,7 @@
498498
{
499499
"cell_type": "code",
500500
"execution_count": null,
501-
"id": "1aef103b",
501+
"id": "e37fa65b",
502502
"metadata": {},
503503
"outputs": [],
504504
"source": [
@@ -510,7 +510,7 @@
510510
},
511511
{
512512
"cell_type": "markdown",
513-
"id": "09ec21ba",
513+
"id": "84d1802b",
514514
"metadata": {},
515515
"source": [
516516
"## ⏭️ Next Steps\n",

0 commit comments

Comments
 (0)