Skip to content

Commit 5f83d4c

Browse files
ropelessropeless
committed
code and documentation improvements
1 parent 78137ec commit 5f83d4c

31 files changed

+948
-637
lines changed

‎docs/1_01_front_matter.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# _front matter_
22

3-
Synthorus version 0.0.0a8, built 2025-11-19 13:04:15 (AUS Eastern Summer Time).
3+
Synthorus version 0.0.0a9, built 2025-11-19 20:28:49 (AUS Eastern Summer Time).
44
A pre-release version.
55

66
These pages form a reference for the software known as Synthorus.

‎docs/1_03_installation.ipynb‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@
3737
"start_time": "2025-11-10T01:56:31.203505Z"
3838
},
3939
"execution": {
40-
"iopub.execute_input": "2025-11-19T02:04:30.358654Z",
41-
"iopub.status.busy": "2025-11-19T02:04:30.358654Z",
42-
"iopub.status.idle": "2025-11-19T02:04:30.559763Z",
43-
"shell.execute_reply": "2025-11-19T02:04:30.559763Z"
40+
"iopub.execute_input": "2025-11-19T09:29:04.416172Z",
41+
"iopub.status.busy": "2025-11-19T09:29:04.415200Z",
42+
"iopub.status.idle": "2025-11-19T09:29:04.617235Z",
43+
"shell.execute_reply": "2025-11-19T09:29:04.617235Z"
4444
}
4545
},
4646
"outputs": [
@@ -51,10 +51,10 @@
5151
"Entity: patient ['_id_', '_count_', 'age']\n",
5252
"\n",
5353
"patient [('_id_', 1), ('_count_', 1), ('age', 'old')]\n",
54-
"patient [('_id_', 2), ('_count_', 2), ('age', 'middle_aged')]\n",
55-
"patient [('_id_', 3), ('_count_', 3), ('age', 'middle_aged')]\n",
56-
"patient [('_id_', 4), ('_count_', 4), ('age', 'young')]\n",
57-
"patient [('_id_', 5), ('_count_', 5), ('age', 'middle_aged')]\n",
54+
"patient [('_id_', 2), ('_count_', 2), ('age', 'young')]\n",
55+
"patient [('_id_', 3), ('_count_', 3), ('age', 'old')]\n",
56+
"patient [('_id_', 4), ('_count_', 4), ('age', 'old')]\n",
57+
"patient [('_id_', 5), ('_count_', 5), ('age', 'old')]\n",
5858
"\n",
5959
"Finished\n"
6060
]

‎docs/2_02_workflow.ipynb‎

Lines changed: 37 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,10 @@
121121
"start_time": "2025-11-11T03:49:36.477856Z"
122122
},
123123
"execution": {
124-
"iopub.execute_input": "2025-11-19T02:04:58.148100Z",
125-
"iopub.status.busy": "2025-11-19T02:04:58.148100Z",
126-
"iopub.status.idle": "2025-11-19T02:04:58.159755Z",
127-
"shell.execute_reply": "2025-11-19T02:04:58.159755Z"
124+
"iopub.execute_input": "2025-11-19T09:29:28.778980Z",
125+
"iopub.status.busy": "2025-11-19T09:29:28.778980Z",
126+
"iopub.status.idle": "2025-11-19T09:29:28.788590Z",
127+
"shell.execute_reply": "2025-11-19T09:29:28.788590Z"
128128
}
129129
},
130130
"outputs": [
@@ -133,18 +133,19 @@
133133
"output_type": "stream",
134134
"text": [
135135
"\"\"\"\n",
136-
"This is an example minimal Synthorus spec file.\n",
136+
"This is an example simple Synthorus spec file.\n",
137137
"\"\"\"\n",
138138
"from synthorus.spec_file.keys import *\n",
139139
"\n",
140140
"spec = {\n",
141-
" # default for all random variables\n",
142-
" states: infer_distinct,\n",
141+
" sensitivity: 0, # no data is sensitive data\n",
142+
" min_cell_size: 0, # no data will be redacted\n",
143+
"\n",
144+
" states: infer_distinct, # default for all random variables\n",
143145
"\n",
144146
" datasources: {\n",
145147
" 'xyz': {\n",
146148
" data_format: csv,\n",
147-
" sensitivity: 0,\n",
148149
" inline: \"\"\"\n",
149150
" X,Y,Z\n",
150151
" y,y,y\n",
@@ -189,10 +190,10 @@
189190
"start_time": "2025-11-11T03:49:36.499060Z"
190191
},
191192
"execution": {
192-
"iopub.execute_input": "2025-11-19T02:04:58.161814Z",
193-
"iopub.status.busy": "2025-11-19T02:04:58.161814Z",
194-
"iopub.status.idle": "2025-11-19T02:04:58.383525Z",
195-
"shell.execute_reply": "2025-11-19T02:04:58.383525Z"
193+
"iopub.execute_input": "2025-11-19T09:29:28.790595Z",
194+
"iopub.status.busy": "2025-11-19T09:29:28.790595Z",
195+
"iopub.status.idle": "2025-11-19T09:29:29.013056Z",
196+
"shell.execute_reply": "2025-11-19T09:29:29.013056Z"
196197
}
197198
},
198199
"outputs": [
@@ -203,7 +204,7 @@
203204
"{\n",
204205
" \"name\": \"spec_tiny\",\n",
205206
" \"author\": \"_unknown_\",\n",
206-
" \"comment\": \"This is an example minimal Synthorus spec file.\",\n",
207+
" \"comment\": \"This is an example simple Synthorus spec file.\",\n",
207208
" \"roots\": [],\n",
208209
" \"rng_n\": 4,\n",
209210
" \"datasources\": {\n",
@@ -232,11 +233,11 @@
232233
" }\n",
233234
" },\n",
234235
" \"rvs\": {\n",
235-
" \"Y\": {\n",
236+
" \"X\": {\n",
236237
" \"states\": \"infer_distinct\",\n",
237238
" \"ensure_none\": false\n",
238239
" },\n",
239-
" \"X\": {\n",
240+
" \"Y\": {\n",
240241
" \"states\": \"infer_distinct\",\n",
241242
" \"ensure_none\": false\n",
242243
" },\n",
@@ -246,22 +247,22 @@
246247
" }\n",
247248
" },\n",
248249
" \"crosstabs\": {\n",
249-
" \"_Y\": {\n",
250+
" \"_X\": {\n",
250251
" \"rvs\": [\n",
251-
" \"Y\"\n",
252+
" \"X\"\n",
252253
" ],\n",
253254
" \"datasource\": \"xyz\",\n",
254255
" \"epsilon\": 0.1,\n",
255-
" \"min_cell_size\": 5.0,\n",
256+
" \"min_cell_size\": 0.0,\n",
256257
" \"max_add_rows\": 1000000\n",
257258
" },\n",
258-
" \"_X\": {\n",
259+
" \"_Y\": {\n",
259260
" \"rvs\": [\n",
260-
" \"X\"\n",
261+
" \"Y\"\n",
261262
" ],\n",
262263
" \"datasource\": \"xyz\",\n",
263264
" \"epsilon\": 0.1,\n",
264-
" \"min_cell_size\": 5.0,\n",
265+
" \"min_cell_size\": 0.0,\n",
265266
" \"max_add_rows\": 1000000\n",
266267
" },\n",
267268
" \"_Z\": {\n",
@@ -270,7 +271,7 @@
270271
" ],\n",
271272
" \"datasource\": \"xyz\",\n",
272273
" \"epsilon\": 0.1,\n",
273-
" \"min_cell_size\": 5.0,\n",
274+
" \"min_cell_size\": 0.0,\n",
274275
" \"max_add_rows\": 1000000\n",
275276
" }\n",
276277
" },\n",
@@ -280,14 +281,14 @@
280281
" \"count_field_name\": \"_count_\",\n",
281282
" \"foreign_field_name\": null,\n",
282283
" \"fields\": {\n",
283-
" \"Y\": {\n",
284-
" \"type\": \"sample\",\n",
285-
" \"rv_name\": \"Y\"\n",
286-
" },\n",
287284
" \"X\": {\n",
288285
" \"type\": \"sample\",\n",
289286
" \"rv_name\": \"X\"\n",
290287
" },\n",
288+
" \"Y\": {\n",
289+
" \"type\": \"sample\",\n",
290+
" \"rv_name\": \"Y\"\n",
291+
" },\n",
291292
" \"Z\": {\n",
292293
" \"type\": \"sample\",\n",
293294
" \"rv_name\": \"Z\"\n",
@@ -353,10 +354,10 @@
353354
"start_time": "2025-11-11T03:49:37.115213Z"
354355
},
355356
"execution": {
356-
"iopub.execute_input": "2025-11-19T02:04:58.385530Z",
357-
"iopub.status.busy": "2025-11-19T02:04:58.385530Z",
358-
"iopub.status.idle": "2025-11-19T02:04:58.389623Z",
359-
"shell.execute_reply": "2025-11-19T02:04:58.389623Z"
357+
"iopub.execute_input": "2025-11-19T09:29:29.015061Z",
358+
"iopub.status.busy": "2025-11-19T09:29:29.015061Z",
359+
"iopub.status.idle": "2025-11-19T09:29:29.019192Z",
360+
"shell.execute_reply": "2025-11-19T09:29:29.019192Z"
360361
}
361362
},
362363
"outputs": [
@@ -393,10 +394,10 @@
393394
"start_time": "2025-11-11T03:49:37.127892Z"
394395
},
395396
"execution": {
396-
"iopub.execute_input": "2025-11-19T02:04:58.391628Z",
397-
"iopub.status.busy": "2025-11-19T02:04:58.391628Z",
398-
"iopub.status.idle": "2025-11-19T02:04:59.073992Z",
399-
"shell.execute_reply": "2025-11-19T02:04:59.073992Z"
397+
"iopub.execute_input": "2025-11-19T09:29:29.021198Z",
398+
"iopub.status.busy": "2025-11-19T09:29:29.021198Z",
399+
"iopub.status.idle": "2025-11-19T09:29:29.686709Z",
400+
"shell.execute_reply": "2025-11-19T09:29:29.686709Z"
400401
}
401402
},
402403
"outputs": [
@@ -432,9 +433,9 @@
432433
"from synthorus_demos.utils.file_helper import print_file_tree\n",
433434
"from synthorus.workflows.make_model_definition_files import make_model_definition_files\n",
434435
"\n",
435-
"with output_directory('my_model_definition_files') as model_definition_dir:\n",
436+
"with output_directory('my_model_definition_files', overwrite=True) as model_definition_dir:\n",
436437
"\n",
437-
" make_model_definition_files(model_spec, model_definition_dir, overwrite=True, log=NO_LOG)\n",
438+
" make_model_definition_files(model_spec, model_definition_dir, log=NO_LOG)\n",
438439
"\n",
439440
" # Show what files got created\n",
440441
" print('-------------------------------------------')\n",

0 commit comments

Comments
 (0)