-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
863 lines (646 loc) · 61.7 KB
/
index.html
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
<!DOCTYPE html>
<html lang="en" data-content_root="./" data-theme="light">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<link rel="manifest" href="site.webmanifest"/>
<title>Welcome to Lumen! — Lumen 1.5.5 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "light";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/mystnb.4510f1fc1dee50b3e5859aac5469c37c29e427902b24a333a5f9fcb2f0b3ac41.css" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=aacd715d" />
<link rel="stylesheet" type="text/css" href="_static/dataframe.css?v=302d74fa" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/pyscript.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/divider.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/floatpanel.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/chat_interface.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/chat_feed.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/katex.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/debugger.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/swipe.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/widgetbox.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/alerts.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/gridbox.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/chat_steps.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/widgets.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/chat_step.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/listpanel.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/gridspec.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/icon.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/regular_table.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/markdown.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/progress.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/booleanstatus.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/chat_message.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/json.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/select.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/editable_slider.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/loading.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/chat_copy_icon.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/button.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/player.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/gridstack.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/layout.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/loadingspinner.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/chat_reaction_icons.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/notifications.css" type="text/css" />
<link rel="stylesheet" href="https://cdn.holoviz.org/panel/1.5.5/dist/css/dataframe.css" type="text/css" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=b8aeccfa"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script src="_static/ServiceHandler.js"></script>
<link rel="icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installation" href="installation.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="light">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="#">
<img src="_static/logo_horizontal.png" class="logo__image only-light" alt="Lumen 1.5.5 documentation - Home"/>
<script>document.write(`<img src="_static/logo_horizontal.png" class="logo__image only-dark" alt="Lumen 1.5.5 documentation - Home"/>`);</script>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="installation.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_ai/getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_ai/how_to/index.html">
How to Guides
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_spec/getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_spec/how_to/index.html">
How to Guides
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="gallery/index.html">
Gallery
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="reference/index.html">
Reference
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="background/index.html">
Background
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/holoviz/lumen" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.holoviz.org/c/lumen/14" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="installation.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_ai/getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_ai/how_to/index.html">
How to Guides
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_spec/getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="lumen_spec/how_to/index.html">
How to Guides
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="gallery/index.html">
Gallery
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="reference/index.html">
Reference
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="background/index.html">
Background
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/holoviz/lumen" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://discourse.holoviz.org/c/lumen/14" title="Discourse" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fab fa-discourse fa-lg" aria-hidden="true"></i>
<span class="sr-only">Discourse</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item"><!-- Adapted from sidebar-nav-bs.html (1.15.2) with the following changes
- Commented out the tag that adds the "Section Navigation" title
- Call generate_toctree_html with startdepth=0
Please update this file when required when bumping the max pin of pydata-sphinx-theme.
-->
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<!-- <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> -->
<div class="bd-toc-item navbar-nav"><ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lumen AI</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="lumen_ai/getting_started/index.html">Getting Started</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/getting_started/using_lumen_ai.html"><svg aria-hidden="true" class="sd-octicon sd-octicon-zap sd-mr-1" height="2.0em" version="1.1" viewbox="0 0 24 24" width="2.0em"><path d="M15.716 1.329a1.341 1.341 0 0 1 2.109 1.55L15.147 9h4.161c1.623 0 2.372 2.016 1.143 3.075L8.102 22.721a1.148 1.148 0 0 1-1.81-1.317L8.996 15H4.674c-1.619 0-2.37-2.008-1.148-3.07l12.19-10.6Zm.452 1.595L4.51 13.061a.25.25 0 0 0 .164.439h5.45a.749.749 0 0 1 .692 1.041l-2.559 6.066 11.215-9.668a.25.25 0 0 0-.164-.439H14a.75.75 0 0 1-.687-1.05Z"></path></svg> Using Lumen AI</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/getting_started/configuring_lumen_ai.html"><svg aria-hidden="true" class="sd-octicon sd-octicon-gear sd-mr-1" height="2.0em" version="1.1" viewbox="0 0 24 24" width="2.0em"><path d="M16 12a4 4 0 1 1-8 0 4 4 0 0 1 8 0Zm-1.5 0a2.5 2.5 0 1 0-5 0 2.5 2.5 0 0 0 5 0Z"></path><path d="M12 1c.266 0 .532.009.797.028.763.055 1.345.617 1.512 1.304l.352 1.45c.019.078.09.171.225.221.247.089.49.19.728.302.13.061.246.044.315.002l1.275-.776c.603-.368 1.411-.353 1.99.147.402.349.78.726 1.128 1.129.501.578.515 1.386.147 1.99l-.776 1.274c-.042.069-.058.185.002.315.112.238.213.481.303.728.048.135.142.205.22.225l1.45.352c.687.167 1.249.749 1.303 1.512.038.531.038 1.063 0 1.594-.054.763-.616 1.345-1.303 1.512l-1.45.352c-.078.019-.171.09-.221.225-.089.248-.19.491-.302.728-.061.13-.044.246-.002.315l.776 1.275c.368.603.353 1.411-.147 1.99-.349.402-.726.78-1.129 1.128-.578.501-1.386.515-1.99.147l-1.274-.776c-.069-.042-.185-.058-.314.002a8.606 8.606 0 0 1-.729.303c-.135.048-.205.142-.225.22l-.352 1.45c-.167.687-.749 1.249-1.512 1.303-.531.038-1.063.038-1.594 0-.763-.054-1.345-.616-1.512-1.303l-.352-1.45c-.019-.078-.09-.171-.225-.221a8.138 8.138 0 0 1-.728-.302c-.13-.061-.246-.044-.315-.002l-1.275.776c-.603.368-1.411.353-1.99-.147-.402-.349-.78-.726-1.128-1.129-.501-.578-.515-1.386-.147-1.99l.776-1.274c.042-.069.058-.185-.002-.314a8.606 8.606 0 0 1-.303-.729c-.048-.135-.142-.205-.22-.225l-1.45-.352c-.687-.167-1.249-.749-1.304-1.512a11.158 11.158 0 0 1 0-1.594c.055-.763.617-1.345 1.304-1.512l1.45-.352c.078-.019.171-.09.221-.225.089-.248.19-.491.302-.728.061-.13.044-.246.002-.315l-.776-1.275c-.368-.603-.353-1.411.147-1.99.349-.402.726-.78 1.129-1.128.578-.501 1.386-.515 1.99-.147l1.274.776c.069.042.185.058.315-.002.238-.112.481-.213.728-.303.135-.048.205-.142.225-.22l.352-1.45c.167-.687.749-1.249 1.512-1.304C11.466 1.01 11.732 1 12 1Zm-.69 1.525c-.055.004-.135.05-.161.161l-.353 1.45a1.832 1.832 0 0 1-1.172 1.277 7.147 7.147 0 0 0-.6.249 1.833 1.833 0 0 1-1.734-.074l-1.274-.776c-.098-.06-.186-.036-.228 0a9.774 9.774 0 0 0-.976.976c-.036.042-.06.131 0 .228l.776 1.274c.314.529.342 1.18.074 1.734a7.147 7.147 0 0 0-.249.6 1.831 1.831 0 0 1-1.278 1.173l-1.45.351c-.11.027-.156.107-.16.162a9.63 9.63 0 0 0 0 1.38c.004.055.05.135.161.161l1.45.353a1.832 1.832 0 0 1 1.277 1.172c.074.204.157.404.249.6.268.553.24 1.204-.074 1.733l-.776 1.275c-.06.098-.036.186 0 .228.301.348.628.675.976.976.042.036.131.06.228 0l1.274-.776a1.83 1.83 0 0 1 1.734-.075c.196.093.396.176.6.25a1.831 1.831 0 0 1 1.173 1.278l.351 1.45c.027.11.107.156.162.16a9.63 9.63 0 0 0 1.38 0c.055-.004.135-.05.161-.161l.353-1.45a1.834 1.834 0 0 1 1.172-1.278 6.82 6.82 0 0 0 .6-.248 1.831 1.831 0 0 1 1.733.074l1.275.776c.098.06.186.036.228 0 .348-.301.675-.628.976-.976.036-.042.06-.131 0-.228l-.776-1.275a1.834 1.834 0 0 1-.075-1.733c.093-.196.176-.396.25-.6a1.831 1.831 0 0 1 1.278-1.173l1.45-.351c.11-.027.156-.107.16-.162a9.63 9.63 0 0 0 0-1.38c-.004-.055-.05-.135-.161-.161l-1.45-.353c-.626-.152-1.08-.625-1.278-1.172a6.576 6.576 0 0 0-.248-.6 1.833 1.833 0 0 1 .074-1.734l.776-1.274c.06-.098.036-.186 0-.228a9.774 9.774 0 0 0-.976-.976c-.042-.036-.131-.06-.228 0l-1.275.776a1.831 1.831 0 0 1-1.733.074 6.88 6.88 0 0 0-.6-.249 1.835 1.835 0 0 1-1.173-1.278l-.351-1.45c-.027-.11-.107-.156-.162-.16a9.63 9.63 0 0 0-1.38 0Z"></path></svg> Configuring Lumen AI</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="lumen_ai/how_to/index.html">How to Guides</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/how_to/custom_agents.html">Custom Agents</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/how_to/custom_analyses.html">Custom Analyses</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/how_to/custom_data_source.html">Custom Data Sources</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/how_to/custom_tools.html">Custom Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/how_to/model_prompts.html">Model Prompts</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_ai/how_to/template_prompts.html">Template Prompts</a></li>
</ul>
</details></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lumen Spec</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="lumen_spec/getting_started/index.html">Getting Started</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="lumen_spec/getting_started/build_dashboard.html"><svg aria-hidden="true" class="sd-octicon sd-octicon-tools sd-mr-1" height="2.0em" version="1.1" viewbox="0 0 24 24" width="2.0em"><path d="M7.875 2.292a.114.114 0 0 0-.032.018A7.239 7.239 0 0 0 4.75 8.25a7.248 7.248 0 0 0 3.654 6.297c.57.327.982.955.941 1.682v.002l-.317 6.058a.75.75 0 1 1-1.498-.078l.317-6.062v-.004c.006-.09-.047-.215-.188-.296A8.749 8.749 0 0 1 3.25 8.25a8.738 8.738 0 0 1 3.732-7.169 1.547 1.547 0 0 1 1.709-.064c.484.292.809.835.809 1.46v4.714a.25.25 0 0 0 .119.213l2.25 1.385c.08.05.182.05.262 0l2.25-1.385a.25.25 0 0 0 .119-.213V2.478c0-.626.325-1.169.81-1.461a1.547 1.547 0 0 1 1.708.064 8.741 8.741 0 0 1 3.732 7.17 8.747 8.747 0 0 1-4.41 7.598c-.14.081-.193.206-.188.296v.004l.318 6.062a.75.75 0 1 1-1.498.078l-.317-6.058v-.002c-.041-.727.37-1.355.94-1.682A7.247 7.247 0 0 0 19.25 8.25a7.239 7.239 0 0 0-3.093-5.94.114.114 0 0 0-.032-.018l-.01-.001c-.003 0-.014 0-.031.01-.036.022-.084.079-.084.177V7.19c0 .608-.315 1.172-.833 1.49l-2.25 1.385a1.75 1.75 0 0 1-1.834 0l-2.25-1.384A1.752 1.752 0 0 1 8 7.192V2.477c0-.098-.048-.155-.084-.176a.068.068 0 0 0-.031-.011l-.01.001Z"></path></svg> Build a dashboard</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_spec/getting_started/core_concepts.html"><svg aria-hidden="true" class="sd-octicon sd-octicon-mortar-board sd-mr-1" height="2.0em" version="1.1" viewbox="0 0 24 24" width="2.0em"><path d="M12.292 2.06v-.001l11.25 4.75a.749.749 0 0 1 0 1.382L19 10.108V15a.75.75 0 0 1-.11.391h-.001a2.84 2.84 0 0 1-.392.482c-.249.256-.625.58-1.163.896-1.08.638-2.776 1.23-5.334 1.23-.673 0-1.286-.041-1.846-.113a.75.75 0 0 1 .192-1.487c.492.063 1.042.1 1.654.1 2.317 0 3.746-.533 4.572-1.021.31-.178.596-.397.849-.65l.079-.085V10.74l-5.208 2.2a.75.75 0 0 1-.584 0L5.75 10.424v3.17c.502.129.96.391 1.327.758.579.578.923 1.41.923 2.428v4.5a.761.761 0 0 1-.345.634 2.157 2.157 0 0 1-.21.117 3.923 3.923 0 0 1-.52.213A6.121 6.121 0 0 1 5 22.532a6.092 6.092 0 0 1-1.925-.288 4.065 4.065 0 0 1-.52-.213 1.816 1.816 0 0 1-.22-.124.757.757 0 0 1-.335-.624v-4.5c0-1.02.344-1.85.923-2.43a2.904 2.904 0 0 1 1.327-.757V9.793L.458 8.19a.75.75 0 0 1 0-1.38l11.25-4.75a.75.75 0 0 1 .584 0ZM12 11.436 21.322 7.5 12 3.564 2.678 7.5ZM5 15c-.377 0-.745.141-1.017.413-.265.265-.483.7-.483 1.368v4.022c.299.105.797.228 1.5.228s1.201-.123 1.5-.228V16.78c0-.669-.218-1.103-.483-1.368A1.433 1.433 0 0 0 5 15Z"></path></svg> Core Concepts</a></li>
<li class="toctree-l2"><a class="reference internal" href="lumen_spec/getting_started/pipelines.html"><svg aria-hidden="true" class="sd-octicon sd-octicon-git-commit sd-mr-1" height="2.0em" version="1.1" viewbox="0 0 24 24" width="2.0em"><path d="M16.944 11h4.306a.75.75 0 0 1 0 1.5h-4.306a5.001 5.001 0 0 1-9.888 0H2.75a.75.75 0 0 1 0-1.5h4.306a5.001 5.001 0 0 1 9.888 0Zm-1.444.75a3.5 3.5 0 1 0-7 0 3.5 3.5 0 0 0 7 0Z"></path></svg> Building a data pipeline</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="lumen_spec/how_to/index.html">How to Guides</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="lumen_spec/how_to/data_intake/index.html">Data Intake</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_intake/files.html">Access Files</a></li>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_intake/cache.html">Cache Data</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lumen_spec/how_to/data_processing/index.html">Data Processing</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_processing/pipeline_python.html">Build Pipelines with Python</a></li>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_processing/branch_pipeline.html">Branch a Pipeline</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lumen_spec/how_to/data_visualization/index.html">Visualize and Deploy</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_visualization/views.html">Define Views</a></li>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_visualization/dashboard_python.html">Visualize Dashboards with Python</a></li>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_visualization/deploy.html">Deploy</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lumen_spec/how_to/validation/index.html">Validation</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/validation/validate.html">Validate Specification</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lumen_spec/how_to/data_output/index.html">Data Output</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/data_output/download_data.html">Enable Data Download</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="lumen_spec/how_to/advanced/index.html">Advanced Topics</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/advanced/local_components.html">Access Custom Components</a></li>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/advanced/auth.html">Configure Authentication</a></li>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/advanced/variables_and_references.html">Reference Variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="lumen_spec/how_to/advanced/callbacks.html">Declare Callbacks</a></li>
</ul>
</details></li>
</ul>
</details></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Lumen</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="gallery/index.html">Gallery</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="gallery/precip.html">Precipitation</a></li>
<li class="toctree-l2"><a class="reference internal" href="gallery/penguins.html">Penguins</a></li>
<li class="toctree-l2"><a class="reference internal" href="gallery/nyc_taxi.html">NYC Taxi Trips</a></li>
<li class="toctree-l2"><a class="reference internal" href="gallery/bikes.html">London Bike Points</a></li>
<li class="toctree-l2"><a class="reference internal" href="gallery/seattle.html">Seattle Weather</a></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="reference/index.html">Reference</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/agent/index.html">Agent</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/SourceAgent.html">SourceAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/ChatAgent.html">ChatAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/TableListAgent.html">TableListAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/LumenBaseAgent.html">LumenBaseAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/AnalystAgent.html">AnalystAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/SQLAgent.html">SQLAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/BaseViewAgent.html">BaseViewAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/AnalysisAgent.html">AnalysisAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/hvPlotAgent.html">hvPlotAgent</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/agent/VegaLiteAgent.html">VegaLiteAgent</a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/variable/index.html">Variable</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/Constant.html">Constant <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: constant</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/EnvVariable.html">EnvVariable <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: env</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/Widget.html">Widget <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: widget</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/Parameter.html">Parameter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: param</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/URLQuery.html">URLQuery <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: url</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/Cookie.html">Cookie <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: cookie</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/UserInfo.html">UserInfo <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: user</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/variable/Header.html">Header <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: header</span></a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/source/index.html">Source</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/source/RESTSource.html">RESTSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: rest</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/InMemorySource.html">InMemorySource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: None</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/FileSource.html">FileSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: file</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/BaseSQLSource.html">BaseSQLSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: None</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/WebsiteSource.html">WebsiteSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: live</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/PanelSessionSource.html">PanelSessionSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: session_info</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/JoinedSource.html">JoinedSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: join</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/DerivedSource.html">DerivedSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: derived</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/JSONSource.html">JSONSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: json</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/DuckDBSource.html">DuckDBSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: duckdb</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/IntakeSource.html">IntakeSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: intake</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/source/IntakeSQLSource.html">IntakeSQLSource <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: intake_sql</span></a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/filter/index.html">Filter</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/filter/ConstantFilter.html">ConstantFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: constant</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/filter/FacetFilter.html">FacetFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: facet</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/filter/ParamFilter.html">ParamFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: param</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/filter/WidgetFilter.html">WidgetFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: widget</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/filter/BinFilter.html">BinFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: bins</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/filter/DateFilter.html">DateFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: date</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/filter/DatetimeFilter.html">DatetimeFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: datetime</span></a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/transform/index.html">Transform</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Filter.html">Filter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: None</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/HistoryTransform.html">HistoryTransform <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: history</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Aggregate.html">Aggregate <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: aggregate</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Sort.html">Sort <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sort</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Query.html">Query <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: query</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Columns.html">Columns <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: columns</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Astype.html">Astype <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: as_type</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Stack.html">Stack <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: stack</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Unstack.html">Unstack <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: unstack</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Iloc.html">Iloc <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: iloc</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Sample.html">Sample <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sample</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Compute.html">Compute <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: compute</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Pivot.html">Pivot <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: pivot</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/PivotTable.html">PivotTable <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: None</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Melt.html">Melt <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: melt</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SetIndex.html">SetIndex <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: set_index</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/ResetIndex.html">ResetIndex <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: reset_index</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Rename.html">Rename <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: rename</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/RenameAxis.html">RenameAxis <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: rename_axis</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Count.html">Count <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: count</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Sum.html">Sum <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sum</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Eval.html">Eval <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: eval</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/DropNA.html">DropNA <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: dropna</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/Corr.html">Corr <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: corr</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/project_lnglat.html">project_lnglat <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: project_lnglat</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLGroupBy.html">SQLGroupBy <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sql_group_by</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLLimit.html">SQLLimit <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sql_limit</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLDistinct.html">SQLDistinct <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sql_distinct</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLCount.html">SQLCount <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sql_count</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLMinMax.html">SQLMinMax <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sql_minmax</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLColumns.html">SQLColumns <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sql_columns</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLFilter.html">SQLFilter <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: sql_filter</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/transform/SQLOverride.html">SQLOverride <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: None</span></a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/view/index.html">View</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/view/Panel.html">Panel <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: panel</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/StringView.html">StringView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: string</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/IndicatorView.html">IndicatorView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: indicator</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/hvOverlayView.html">hvOverlayView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: hv_overlay</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/Table.html">Table <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: table</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/DownloadView.html">DownloadView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: download</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/PerspectiveView.html">PerspectiveView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: perspective</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/VegaLiteView.html">VegaLiteView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: vegalite</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/AltairView.html">AltairView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: altair</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/YdataProfilingView.html">YdataProfilingView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: ydata_profiling</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/hvPlotUIView.html">hvPlotUIView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: hvplot_ui</span></a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/view/hvPlotView.html">hvPlotView <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: hvplot</span></a></li>
</ul>
</details></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="reference/auth/index.html">Auth</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l3"><a class="reference internal" href="reference/auth/Auth.html">Auth</a></li>
<li class="toctree-l3"><a class="reference internal" href="reference/auth/YamlAuthMapperPlugin.html">YamlAuthMapperPlugin <span class="sd-sphinx-override sd-badge sd-bg-primary sd-bg-text-primary">type: yaml</span></a></li>
</ul>
</details></li>
</ul>
</details></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="background/index.html">Background</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="background/lumen_in_python.html">Lumen in Python</a></li>
<li class="toctree-l2"><a class="reference internal" href="background/pipeline_branching.html">Pipeline branching</a></li>
</ul>
</details></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none"></div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="welcome-to-lumen">
<h1>Welcome to Lumen!<a class="headerlink" href="#welcome-to-lumen" title="Link to this heading">#</a></h1>
<img src="./_static/ai-diagram.png" alt="Lumen AI Diagram" width="100%"/>
<p>Lumen is a fully open-source and extensible agent based framework for chatting with data and for retrieval augmented generation (RAG). The declarative nature of Lumen’s data model make it possible for LLMs to easily generate entire data transformation pipelines, visualizations and other many other types of output. Once generated the data pipelines and visual output can be easily serialized, making it possible to share them, to continue the analysis in a notebook and/or build entire dashboards.</p>
<ul class="simple">
<li><p><strong>Generate SQL</strong>: Generate data pipelines on top of local or remote files, SQL databases or your data lake.</p></li>
<li><p><strong>Provide context and embeddings</strong>: Give Lumen access to your documents to give the LLM the context it needs.</p></li>
<li><p><strong>Visualize your data</strong>: Generate everything from charts to powerful data tables or entire <strong>dashboards</strong> using natural language.</p></li>
<li><p><strong>Inspect, validate and edit results</strong>: All LLM outputs can easily be inspected for mistakes, refined, and manually edited if needed.</p></li>
<li><p><strong>Summarize results and key insights</strong>: Have the LLM summarize key results and extract important insights.</p></li>
<li><p><strong>Custom analyses, agents and tools</strong>: Extend Lumen custom agents, tools, and analyses to generate deep insights tailored to your domain.</p></li>
</ul>
<p>Lumen sets itself apart from other agent based frameworks in that it focuses on being fully open and extensible. With powerful internal primitives for expressing complex data transformations the LLM can gain insights into your datasets out-of-the box and can be further tailored with custom agents, analyses and tools to empower even non-programmers to perform complex analyses without having to code. The customization makes it possible to generate any type of output, allow the user and the LLM to perform analyses tailored to your domain and look up additional information and context easily. Since Lumen is built on <a class="reference external" href="https://panel.holoviz.org">Panel</a> it can render almost any type of output with little to no effort, ensuring that even the most esoteric usecase is easily possible.</p>
<p>The declarative Lumen data model further sets it apart from other tools, making it easy for LLMs to populate custom components and making it easy for the user to share the results. Entire multi-step data transformation pipelines be they in SQL or Python can easily be captured and used to drive custom visualizations, interactive tables and more. Once generated the declarative nature of the Lumen specification allows them to be shared, reproducing them in a notebook or composing them through a drag-and-drop interface into a dashboard.</p>
<div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils">
<div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-2 sd-row-cols-md-2 sd-row-cols-lg-4 sd-g-1 sd-g-xs-1 sd-g-sm-1 sd-g-md-1 sd-g-lg-2 docutils">
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
<svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-desktop-download sd-mr-1" viewBox="0 0 24 24" aria-hidden="true"><path d="M11.25 9.331V.75a.75.75 0 0 1 1.5 0v8.58l1.949-2.11A.75.75 0 1 1 15.8 8.237l-3.25 3.52a.75.75 0 0 1-1.102 0l-3.25-3.52A.75.75 0 1 1 9.3 7.22l1.949 2.111Z"></path><path d="M2.5 3.75v11.5c0 .138.112.25.25.25h18.5a.25.25 0 0 0 .25-.25V3.75a.25.25 0 0 0-.25-.25h-5.5a.75.75 0 0 1 0-1.5h5.5c.966 0 1.75.784 1.75 1.75v11.5A1.75 1.75 0 0 1 21.25 17h-6.204c.171 1.375.805 2.652 1.769 3.757A.752.752 0 0 1 16.25 22h-8.5a.75.75 0 0 1-.566-1.243c.965-1.105 1.599-2.382 1.77-3.757H2.75A1.75 1.75 0 0 1 1 15.25V3.75C1 2.784 1.784 2 2.75 2h5.5a.75.75 0 0 1 0 1.5h-5.5a.25.25 0 0 0-.25.25ZM10.463 17c-.126 1.266-.564 2.445-1.223 3.5h5.52c-.66-1.055-1.098-2.234-1.223-3.5Z"></path></svg> Installation</div>
<p class="sd-card-text">Install Lumen in a few easy steps</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="installation.html"><span class="doc">Installation</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
<svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-zap sd-mr-1" viewBox="0 0 24 24" aria-hidden="true"><path d="M15.716 1.329a1.341 1.341 0 0 1 2.109 1.55L15.147 9h4.161c1.623 0 2.372 2.016 1.143 3.075L8.102 22.721a1.148 1.148 0 0 1-1.81-1.317L8.996 15H4.674c-1.619 0-2.37-2.008-1.148-3.07l12.19-10.6Zm.452 1.595L4.51 13.061a.25.25 0 0 0 .164.439h5.45a.749.749 0 0 1 .692 1.041l-2.559 6.066 11.215-9.668a.25.25 0 0 0-.164-.439H14a.75.75 0 0 1-.687-1.05Z"></path></svg> Exploration with Lumen AI</div>
<p class="sd-card-text">How to explore your data with Lumen AI.</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="lumen_ai/getting_started/using_lumen_ai.html"><span class="doc"> Using Lumen AI</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
<svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-tools sd-mr-1" viewBox="0 0 24 24" aria-hidden="true"><path d="M7.875 2.292a.114.114 0 0 0-.032.018A7.239 7.239 0 0 0 4.75 8.25a7.248 7.248 0 0 0 3.654 6.297c.57.327.982.955.941 1.682v.002l-.317 6.058a.75.75 0 1 1-1.498-.078l.317-6.062v-.004c.006-.09-.047-.215-.188-.296A8.749 8.749 0 0 1 3.25 8.25a8.738 8.738 0 0 1 3.732-7.169 1.547 1.547 0 0 1 1.709-.064c.484.292.809.835.809 1.46v4.714a.25.25 0 0 0 .119.213l2.25 1.385c.08.05.182.05.262 0l2.25-1.385a.25.25 0 0 0 .119-.213V2.478c0-.626.325-1.169.81-1.461a1.547 1.547 0 0 1 1.708.064 8.741 8.741 0 0 1 3.732 7.17 8.747 8.747 0 0 1-4.41 7.598c-.14.081-.193.206-.188.296v.004l.318 6.062a.75.75 0 1 1-1.498.078l-.317-6.058v-.002c-.041-.727.37-1.355.94-1.682A7.247 7.247 0 0 0 19.25 8.25a7.239 7.239 0 0 0-3.093-5.94.114.114 0 0 0-.032-.018l-.01-.001c-.003 0-.014 0-.031.01-.036.022-.084.079-.084.177V7.19c0 .608-.315 1.172-.833 1.49l-2.25 1.385a1.75 1.75 0 0 1-1.834 0l-2.25-1.384A1.752 1.752 0 0 1 8 7.192V2.477c0-.098-.048-.155-.084-.176a.068.068 0 0 0-.031-.011l-.01.001Z"></path></svg> Build a Lumen Spec dashboard</div>
<p class="sd-card-text">How to build a Lumen dashboard</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="lumen_spec/getting_started/build_dashboard.html"><span class="doc"> Build a dashboard</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
<svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-mortar-board sd-mr-1" viewBox="0 0 24 24" aria-hidden="true"><path d="M12.292 2.06v-.001l11.25 4.75a.749.749 0 0 1 0 1.382L19 10.108V15a.75.75 0 0 1-.11.391h-.001a2.84 2.84 0 0 1-.392.482c-.249.256-.625.58-1.163.896-1.08.638-2.776 1.23-5.334 1.23-.673 0-1.286-.041-1.846-.113a.75.75 0 0 1 .192-1.487c.492.063 1.042.1 1.654.1 2.317 0 3.746-.533 4.572-1.021.31-.178.596-.397.849-.65l.079-.085V10.74l-5.208 2.2a.75.75 0 0 1-.584 0L5.75 10.424v3.17c.502.129.96.391 1.327.758.579.578.923 1.41.923 2.428v4.5a.761.761 0 0 1-.345.634 2.157 2.157 0 0 1-.21.117 3.923 3.923 0 0 1-.52.213A6.121 6.121 0 0 1 5 22.532a6.092 6.092 0 0 1-1.925-.288 4.065 4.065 0 0 1-.52-.213 1.816 1.816 0 0 1-.22-.124.757.757 0 0 1-.335-.624v-4.5c0-1.02.344-1.85.923-2.43a2.904 2.904 0 0 1 1.327-.757V9.793L.458 8.19a.75.75 0 0 1 0-1.38l11.25-4.75a.75.75 0 0 1 .584 0ZM12 11.436 21.322 7.5 12 3.564 2.678 7.5ZM5 15c-.377 0-.745.141-1.017.413-.265.265-.483.7-.483 1.368v4.022c.299.105.797.228 1.5.228s1.201-.123 1.5-.228V16.78c0-.669-.218-1.103-.483-1.368A1.433 1.433 0 0 0 5 15Z"></path></svg> Lumen Spec Core concepts</div>
<p class="sd-card-text">Get an overview of the core concepts of Lumen</p>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="lumen_spec/getting_started/core_concepts.html"><span class="doc"> Core Concepts</span></a></div>
</div>
<div class="sd-col sd-d-flex-row docutils">
<div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm sd-card-hover docutils">
<div class="sd-card-body docutils">
<div class="sd-card-title sd-font-weight-bold docutils">
<svg version="1.1" width="2.0em" height="2.0em" class="sd-octicon sd-octicon-git-commit sd-mr-1" viewBox="0 0 24 24" aria-hidden="true"><path d="M16.944 11h4.306a.75.75 0 0 1 0 1.5h-4.306a5.001 5.001 0 0 1-9.888 0H2.75a.75.75 0 0 1 0-1.5h4.306a5.001 5.001 0 0 1 9.888 0Zm-1.444.75a3.5 3.5 0 1 0-7 0 3.5 3.5 0 0 0 7 0Z"></path></svg> Lumen Spec Data Pipelines</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
<div class="toctree-wrapper compound">
</div>
</div>
<a class="sd-stretched-link sd-hide-link-text reference internal" href="lumen_spec/getting_started/pipelines.html"><span class="doc"> Building a data pipeline</span></a></div>
</div>
</div>
</div>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="right-next"
href="installation.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Installation</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/index.md.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2020-2025, HoloViz Developers.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.4.
</p></div>
</div>
</div>
</footer>
</body>
</html>