246
246
< h2 id ="toc-title "> On this page</ h2 >
247
247
248
248
< ul >
249
- < li > < a href ="#installation-and-setup " id ="toc-installation-and-setup " class ="nav-link active " data-scroll-target ="#installation-and-setup "> Installation and setup</ a >
250
- < ul class ="collapse ">
251
- < li > < a href ="#install-from-pypi " id ="toc-install-from-pypi " class ="nav-link " data-scroll-target ="#install-from-pypi "> Install from PyPI</ a > </ li >
249
+ < li > < a href ="#install-from-pypi " id ="toc-install-from-pypi " class ="nav-link active " data-scroll-target ="#install-from-pypi "> Install from PyPI</ a > </ li >
252
250
< li > < a href ="#data-platform-setup " id ="toc-data-platform-setup " class ="nav-link " data-scroll-target ="#data-platform-setup "> Data platform setup</ a > </ li >
253
251
< li > < a href ="#ai-platform-setup " id ="toc-ai-platform-setup " class ="nav-link " data-scroll-target ="#ai-platform-setup "> AI platform setup</ a > </ li >
254
252
< li > < a href ="#next-steps " id ="toc-next-steps " class ="nav-link " data-scroll-target ="#next-steps "> Next steps</ a > </ li >
255
- </ ul > </ li >
256
253
</ ul >
257
254
< div class ="toc-actions "> < ul > < li > < a href ="https://github.com/ibis-project/ibis-birdbrain/edit/main/docs/install.qmd " class ="toc-action "> < i class ="bi bi-github "> </ i > Edit this page</ a > </ li > < li > < a href ="https://github.com/ibis-project/ibis-birdbrain/issues/new/choose " class ="toc-action "> < i class ="bi empty "> </ i > Report an issue</ a > </ li > </ ul > </ div > </ nav >
258
255
</ div >
259
256
<!-- main -->
260
257
< main class ="content " id ="quarto-document-content ">
261
258
259
+ < header id ="title-block-header " class ="quarto-title-block default ">
260
+ < div class ="quarto-title ">
261
+ < h1 class ="title "> Installation and setup</ h1 >
262
+ </ div >
263
+
264
+
265
+
266
+ < div class ="quarto-title-meta ">
262
267
268
+
269
+
270
+
271
+ </ div >
272
+
273
+
274
+
275
+ </ header >
263
276
264
277
265
- < section id ="installation-and-setup " class ="level1 ">
266
- < h1 > Installation and setup</ h1 >
267
278
< p > This page describes how to install and setup Ibis Birdbrain.</ p >
268
279
< section id ="install-from-pypi " class ="level2 ">
269
280
< h2 class ="anchored " data-anchor-id ="install-from-pypi "> Install from PyPI</ h2 >
270
281
< div class ="sourceCode " id ="cb1 "> < pre class ="sourceCode bash code-with-copy "> < code class ="sourceCode bash "> < span id ="cb1-1 "> < a href ="#cb1-1 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="ex "> pip</ span > install ibis-birdbrain</ span > </ code > < button title ="Copy to Clipboard " class ="code-copy-button "> < i class ="bi "> </ i > </ button > </ pre > </ div >
271
282
</ section >
272
283
< section id ="data-platform-setup " class ="level2 ">
273
284
< h2 class ="anchored " data-anchor-id ="data-platform-setup "> Data platform setup</ h2 >
285
+ < p > Create an Ibis connection:</ p >
274
286
< div class ="callout callout-style-default callout-warning callout-titled ">
275
287
< div class ="callout-header d-flex align-content-center ">
276
288
< div class ="callout-icon-container ">
@@ -281,25 +293,25 @@ <h2 class="anchored" data-anchor-id="data-platform-setup">Data platform setup</h
281
293
</ div >
282
294
</ div >
283
295
< div class ="callout-body-container callout-body ">
284
- < p > Documentation coming soon! </ p >
296
+ < p > Only DuckDB is installed by default. For now, you need to install other backends manually with Ibis. </ p >
285
297
</ div >
286
298
</ div >
287
- < div class ="callout callout-style-default callout-warning callout-titled ">
288
- < div class ="callout-header d-flex align-content-center ">
289
- < div class ="callout-icon-container ">
290
- < i class ="callout-icon "> </ i >
291
- </ div >
292
- < div class ="callout-title-container flex-fill ">
293
- Warning
294
- </ div >
295
- </ div >
296
- < div class ="callout-body-container callout-body ">
297
- < p > Only DuckDB supported for now. All 18+ Ibis backends coming soon.</ p >
299
+ < div id ="9af055c5 " class ="cell " data-execution_count ="1 ">
300
+ < div class ="sourceCode cell-code " id ="cb2 "> < pre class ="sourceCode python code-with-copy "> < code class ="sourceCode python "> < span id ="cb2-1 "> < a href ="#cb2-1 " aria-hidden ="true " tabindex ="-1 "> </ a > < span class ="im "> import</ span > ibis</ span >
301
+ < span id ="cb2-2 "> < a href ="#cb2-2 " aria-hidden ="true " tabindex ="-1 "> </ a > </ span >
302
+ < span id ="cb2-3 "> < a href ="#cb2-3 " aria-hidden ="true " tabindex ="-1 "> </ a > backend < span class ="op "> =</ span > < span class ="st "> "duckdb"</ span > </ span >
303
+ < span id ="cb2-4 "> < a href ="#cb2-4 " aria-hidden ="true " tabindex ="-1 "> </ a > backend_uri < span class ="op "> =</ span > < span class ="st "> ""</ span > </ span >
304
+ < span id ="cb2-5 "> < a href ="#cb2-5 " aria-hidden ="true " tabindex ="-1 "> </ a > </ span >
305
+ < span id ="cb2-6 "> < a href ="#cb2-6 " aria-hidden ="true " tabindex ="-1 "> </ a > con < span class ="op "> =</ span > ibis.< span class ="ex "> connect</ span > (< span class ="ss "> f"</ span > < span class ="sc "> {</ span > backend< span class ="sc "> }</ span > < span class ="ss "> ://</ span > < span class ="sc "> {</ span > backend_uri< span class ="sc "> }</ span > < span class ="ss "> "</ span > )</ span >
306
+ < span id ="cb2-7 "> < a href ="#cb2-7 " aria-hidden ="true " tabindex ="-1 "> </ a > con</ span > </ code > < button title ="Copy to Clipboard " class ="code-copy-button "> < i class ="bi "> </ i > </ button > </ pre > </ div >
307
+ < div class ="cell-output cell-output-display " data-execution_count ="1 ">
308
+ < pre > < code > <ibis.backends.duckdb.Backend at 0x1487a2890></ code > </ pre >
298
309
</ div >
299
310
</ div >
300
311
</ section >
301
312
< section id ="ai-platform-setup " class ="level2 ">
302
313
< h2 class ="anchored " data-anchor-id ="ai-platform-setup "> AI platform setup</ h2 >
314
+ < p > See < a href ="https://www.askmarvin.ai/docs/configuration/settings/ "> Marvin documentation for setup</ a > .</ p >
303
315
< div class ="callout callout-style-default callout-warning callout-titled ">
304
316
< div class ="callout-header d-flex align-content-center ">
305
317
< div class ="callout-icon-container ">
@@ -310,34 +322,15 @@ <h2 class="anchored" data-anchor-id="ai-platform-setup">AI platform setup</h2>
310
322
</ div >
311
323
</ div >
312
324
< div class ="callout-body-container callout-body ">
313
- < p > Documentation coming soon! </ p >
325
+ < p > Only OpenAI and Azure OpenAI are supported for now. </ p >
314
326
</ div >
315
327
</ div >
316
- < div class ="callout callout-style-default callout-warning callout-titled ">
317
- < div class ="callout-header d-flex align-content-center ">
318
- < div class ="callout-icon-container ">
319
- < i class ="callout-icon "> </ i >
320
- </ div >
321
- < div class ="callout-title-container flex-fill ">
322
- Warning
323
- </ div >
324
- </ div >
325
- < div class ="callout-body-container callout-body ">
326
- < p > Only Azure OpenAI is supported for now. All Marvin providers coming soon.</ p >
327
- </ div >
328
- </ div >
329
- < p > Create the < code > ~/.birdbrain/.env</ code > file:</ p >
330
- < div class ="sourceCode " id ="cb2 "> < pre class ="sourceCode txt code-with-copy "> < code class ="sourceCode default "> < span id ="cb2-1 "> < a href ="#cb2-1 " aria-hidden ="true " tabindex ="-1 "> </ a > MARVIN_AZURE_OPENAI_API_KEY="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"</ span >
331
- < span id ="cb2-2 "> < a href ="#cb2-2 " aria-hidden ="true " tabindex ="-1 "> </ a > MARVIN_AZURE_OPENAI_API_BASE="https://birdbrain.openai.azure.com"</ span >
332
- < span id ="cb2-3 "> < a href ="#cb2-3 " aria-hidden ="true " tabindex ="-1 "> </ a > MARVIN_AZURE_OPENAI_DEPLOYMENT_NAME="birdbrain-4-32k"</ span >
333
- < span id ="cb2-4 "> < a href ="#cb2-4 " aria-hidden ="true " tabindex ="-1 "> </ a > MARVIN_AZURE_OPENAI_API_TYPE="azure"</ span > </ code > < button title ="Copy to Clipboard " class ="code-copy-button "> < i class ="bi "> </ i > </ button > </ pre > </ div >
334
328
</ section >
335
329
< section id ="next-steps " class ="level2 ">
336
330
< h2 class ="anchored " data-anchor-id ="next-steps "> Next steps</ h2 >
337
331
< p > < a href ="./tutorials/cli.html "> Learn how get started with Ibis Birdbrain’s CLI</ a > .</ p >
338
332
339
333
340
- </ section >
341
334
</ section >
342
335
343
336
< a onclick ="window.scrollTo(0, 0); return false; " role ="button " id ="quarto-back-to-top "> < i class ="bi bi-arrow-up "> </ i > Back to top</ a > </ main > <!-- /main -->
0 commit comments