-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexamples_notebook.py
More file actions
506 lines (365 loc) · 11.1 KB
/
examples_notebook.py
File metadata and controls
506 lines (365 loc) · 11.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
import marimo
__generated_with = "0.11.0"
app = marimo.App(width="wide")
@app.cell
def _():
import asyncio
import marimo as mo
from fmtools.exceptions import AppleFMSetupError
return AppleFMSetupError, asyncio, mo
@app.cell
def _(mo):
mo.md(
"""
# FMTools Examples Notebook
This notebook mirrors the repository's example surface:
- standalone scripts in `examples/`
- numbered scenarios in `use_cases/*/example.py`
- desktop app run command from `examples/toga_local_chat_app/`
All SDK-dependent examples follow the same custom setup exception flow (`AppleFMSetupError`).
## Environment assumptions for live runs
- Apple Silicon (M-series), macOS 26+
- `uv sync --all-groups`
- `apple_fm_sdk` available locally
- Optional extras for some demos:
- `uv pip install fmtools[arrow]`
- `uv pip install fmtools[adapters]`
- `uv pip install briefcase toga-cocoa` (desktop app)
## How to use
- Read each markdown section for context.
- Toggle `RUN_LIVE_DEMOS = True` to run `examples/*.py` demo code.
- Toggle `RUN_USE_CASES = True` to execute `use_cases/*/example.py`.
- If SDK/model setup is missing, cells print `AppleFMSetupError` with troubleshooting steps.
"""
)
return
@app.cell
def _():
RUN_LIVE_DEMOS = False
RUN_USE_CASES = False
return RUN_LIVE_DEMOS, RUN_USE_CASES
@app.cell
def _(AppleFMSetupError, asyncio):
def run_async_demo(coro_fn):
try:
return asyncio.run(coro_fn())
except AppleFMSetupError as exc:
print(exc)
return None
def run_sync_demo(fn):
try:
return fn()
except AppleFMSetupError as exc:
print(exc)
return None
return run_async_demo, run_sync_demo
@app.cell
def _():
import subprocess
import sys
from pathlib import Path
repo_root = Path(__file__).resolve().parents[1]
def run_script(relative_path: str) -> int:
script = repo_root / relative_path
print(f"$ {sys.executable} {script.relative_to(repo_root)}")
completed = subprocess.run([sys.executable, str(script)], cwd=repo_root)
return completed.returncode
return (run_script,)
@app.cell
def _(mo):
mo.md("## 1) `simple_inference.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.simple_inference import main as simple_inference_main
if RUN_LIVE_DEMOS:
run_async_demo(simple_inference_main)
else:
print("Set RUN_LIVE_DEMOS = True to run simple_inference.py")
return (simple_inference_main,)
@app.cell
def _(mo):
mo.md("## 2) `streaming_example.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.streaming_example import main as streaming_example_main
if RUN_LIVE_DEMOS:
run_async_demo(streaming_example_main)
else:
print("Set RUN_LIVE_DEMOS = True to run streaming_example.py")
return (streaming_example_main,)
@app.cell
def _(mo):
mo.md("## 3) `transcript_processing.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_sync_demo):
from examples.transcript_processing import main as transcript_processing_main
if RUN_LIVE_DEMOS:
run_sync_demo(transcript_processing_main)
else:
print("Set RUN_LIVE_DEMOS = True to run transcript_processing.py")
return (transcript_processing_main,)
@app.cell
def _(mo):
mo.md("## 4) `extraction_cache.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.extraction_cache import main as extraction_cache_main
if RUN_LIVE_DEMOS:
run_async_demo(extraction_cache_main)
else:
print("Set RUN_LIVE_DEMOS = True to run extraction_cache.py")
return (extraction_cache_main,)
@app.cell
def _(mo):
mo.md("## 5) `functional_pipeline.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.functional_pipeline import main as functional_pipeline_main
if RUN_LIVE_DEMOS:
run_async_demo(functional_pipeline_main)
else:
print("Set RUN_LIVE_DEMOS = True to run functional_pipeline.py")
return (functional_pipeline_main,)
@app.cell
def _(mo):
mo.md("## 6) `custom_backend.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.custom_backend import main as custom_backend_main
if RUN_LIVE_DEMOS:
run_async_demo(custom_backend_main)
else:
print("Set RUN_LIVE_DEMOS = True to run custom_backend.py")
return (custom_backend_main,)
@app.cell
def _(mo):
mo.md("## 7) `trio_adapter.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.trio_adapter import main as trio_adapter_main
if RUN_LIVE_DEMOS:
run_async_demo(trio_adapter_main)
else:
print("Set RUN_LIVE_DEMOS = True to run trio_adapter.py")
return (trio_adapter_main,)
@app.cell
def _(mo):
mo.md("## 8) `context_scope.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.context_scope import main as context_scope_main
if RUN_LIVE_DEMOS:
run_async_demo(context_scope_main)
else:
print("Set RUN_LIVE_DEMOS = True to run context_scope.py")
return (context_scope_main,)
@app.cell
def _(mo):
mo.md("## 9) `free_threading.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_sync_demo):
from examples.free_threading import main as free_threading_main
if RUN_LIVE_DEMOS:
run_sync_demo(free_threading_main)
else:
print("Set RUN_LIVE_DEMOS = True to run free_threading.py")
return (free_threading_main,)
@app.cell
def _(mo):
mo.md("## 10) `mmap_scanner.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.mmap_scanner import main as mmap_scanner_main
if RUN_LIVE_DEMOS:
run_async_demo(mmap_scanner_main)
else:
print("Set RUN_LIVE_DEMOS = True to run mmap_scanner.py")
return (mmap_scanner_main,)
@app.cell
def _(mo):
mo.md("## 11) `hot_folder_watcher.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.hot_folder_watcher import main as hot_folder_watcher_main
if RUN_LIVE_DEMOS:
run_async_demo(hot_folder_watcher_main)
else:
print("Set RUN_LIVE_DEMOS = True to run hot_folder_watcher.py")
return (hot_folder_watcher_main,)
@app.cell
def _(mo):
mo.md("## 12) `jit_diagnostics.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.jit_diagnostics import main as jit_diagnostics_main
if RUN_LIVE_DEMOS:
run_async_demo(jit_diagnostics_main)
else:
print("Set RUN_LIVE_DEMOS = True to run jit_diagnostics.py")
return (jit_diagnostics_main,)
@app.cell
def _(mo):
mo.md("## 13) `arrow_bridge.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.arrow_bridge import main as arrow_bridge_main
if RUN_LIVE_DEMOS:
run_async_demo(arrow_bridge_main)
else:
print("Set RUN_LIVE_DEMOS = True to run arrow_bridge.py")
return (arrow_bridge_main,)
@app.cell
def _(mo):
mo.md("## 14) `code_auditor.py`")
return
@app.cell
def _(RUN_LIVE_DEMOS, run_async_demo):
from examples.code_auditor import main as code_auditor_main
if RUN_LIVE_DEMOS:
run_async_demo(code_auditor_main)
else:
print("Set RUN_LIVE_DEMOS = True to run code_auditor.py")
return (code_auditor_main,)
@app.cell
def _(mo):
mo.md("## 15) `use_cases/01_pipeline_operators/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/01_pipeline_operators/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 01.")
return
@app.cell
def _(mo):
mo.md("## 16) `use_cases/02_decorators/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/02_decorators/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 02.")
return
@app.cell
def _(mo):
mo.md("## 17) `use_cases/03_async_generators/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/03_async_generators/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 03.")
return
@app.cell
def _(mo):
mo.md("## 18) `use_cases/04_ecosystem_polars/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/04_ecosystem_polars/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 04.")
return
@app.cell
def _(mo):
mo.md("## 19) `use_cases/05_dspy_optimization/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/05_dspy_optimization/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 05.")
return
@app.cell
def _(mo):
mo.md("## 20) `use_cases/06_fastapi_integration/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/06_fastapi_integration/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 06.")
return
@app.cell
def _(mo):
mo.md("## 21) `use_cases/07_stress_test_throughput/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/07_stress_test_throughput/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 07.")
return
@app.cell
def _(mo):
mo.md("## 22) `use_cases/08_context_limit_test/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/08_context_limit_test/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 08.")
return
@app.cell
def _(mo):
mo.md("## 23) `use_cases/09_enhanced_debugging/example.py`")
return
@app.cell
def _(RUN_USE_CASES, run_script):
if RUN_USE_CASES:
run_script("use_cases/09_enhanced_debugging/example.py")
else:
print("Set RUN_USE_CASES = True to run use case 09.")
return
@app.cell
def _(mo):
mo.md(
"""
## 24) Desktop app example (`examples/toga_local_chat_app/`)
This app is started from CLI or Briefcase rather than directly as a single script.
Recommended command:
```bash
uv run fmtools chat
```
"""
)
return
@app.cell
def _(mo):
mo.md(
"""
## Notebook tips
- Keep `RUN_LIVE_DEMOS = False` and `RUN_USE_CASES = False` when editing.
- Use per-script CLI runs for focused output:
- `fmtools example <name>`
- `uv run python use_cases/<NN_name>/example.py`
- For setup verification:
- `uv run fmtools doctor`
- For full example validation:
- `uv run fmtools smoke`
"""
)
return
if __name__ == "__main__":
app.run()