Skip to content

Commit 8bb4d27

Browse files
deploy: a6514d0
1 parent dddd988 commit 8bb4d27

File tree

6 files changed

+103
-99
lines changed

6 files changed

+103
-99
lines changed

install.html

+31-38
Original file line numberDiff line numberDiff line change
@@ -246,31 +246,43 @@
246246
<h2 id="toc-title">On this page</h2>
247247

248248
<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>
252250
<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>
253251
<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>
254252
<li><a href="#next-steps" id="toc-next-steps" class="nav-link" data-scroll-target="#next-steps">Next steps</a></li>
255-
</ul></li>
256253
</ul>
257254
<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>
258255
</div>
259256
<!-- main -->
260257
<main class="content" id="quarto-document-content">
261258

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">
262267

268+
269+
270+
271+
</div>
272+
273+
274+
275+
</header>
263276

264277

265-
<section id="installation-and-setup" class="level1">
266-
<h1>Installation and setup</h1>
267278
<p>This page describes how to install and setup Ibis Birdbrain.</p>
268279
<section id="install-from-pypi" class="level2">
269280
<h2 class="anchored" data-anchor-id="install-from-pypi">Install from PyPI</h2>
270281
<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>
271282
</section>
272283
<section id="data-platform-setup" class="level2">
273284
<h2 class="anchored" data-anchor-id="data-platform-setup">Data platform setup</h2>
285+
<p>Create an Ibis connection:</p>
274286
<div class="callout callout-style-default callout-warning callout-titled">
275287
<div class="callout-header d-flex align-content-center">
276288
<div class="callout-icon-container">
@@ -281,25 +293,25 @@ <h2 class="anchored" data-anchor-id="data-platform-setup">Data platform setup</h
281293
</div>
282294
</div>
283295
<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>
285297
</div>
286298
</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>&lt;ibis.backends.duckdb.Backend at 0x1487a2890&gt;</code></pre>
298309
</div>
299310
</div>
300311
</section>
301312
<section id="ai-platform-setup" class="level2">
302313
<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>
303315
<div class="callout callout-style-default callout-warning callout-titled">
304316
<div class="callout-header d-flex align-content-center">
305317
<div class="callout-icon-container">
@@ -310,34 +322,15 @@ <h2 class="anchored" data-anchor-id="ai-platform-setup">AI platform setup</h2>
310322
</div>
311323
</div>
312324
<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>
314326
</div>
315327
</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>
334328
</section>
335329
<section id="next-steps" class="level2">
336330
<h2 class="anchored" data-anchor-id="next-steps">Next steps</h2>
337331
<p><a href="./tutorials/cli.html">Learn how get started with Ibis Birdbrain’s CLI</a>.</p>
338332

339333

340-
</section>
341334
</section>
342335

343336
<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 -->

posts.html

+5-5
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ <h1 class="title">Posts</h1>
263263
</div>
264264
</div>
265265
<div class="list grid quarto-listing-cols-3">
266-
<div class="g-col-1" data-index="0" data-categories="LLMs and data" data-listing-date-sort="1697414400000" data-listing-file-modified-sort="1709657790544" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="435">
266+
<div class="g-col-1" data-index="0" data-categories="LLMs and data" data-listing-date-sort="1697414400000" data-listing-file-modified-sort="1709659178645" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="435">
267267
<a href="./posts/llms-and-data-pt4/index.html" class="quarto-grid-link">
268268
<div class="quarto-grid-item card h-100 card-left">
269269
<p class="card-img-top"><img src="posts/llms-and-data-pt4/images/figure1.png" style="height: 150px;" class="thumbnail-image card-img"/></p>
@@ -291,7 +291,7 @@ <h5 class="no-anchor card-title listing-title">
291291
</div>
292292
</a>
293293
</div>
294-
<div class="g-col-1" data-index="1" data-categories="LLMs and data" data-listing-date-sort="1697328000000" data-listing-file-modified-sort="1709657790544" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="444">
294+
<div class="g-col-1" data-index="1" data-categories="LLMs and data" data-listing-date-sort="1697328000000" data-listing-file-modified-sort="1709659178641" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="3" data-listing-word-count-sort="444">
295295
<a href="./posts/llms-and-data-pt3/index.html" class="quarto-grid-link">
296296
<div class="quarto-grid-item card h-100 card-left">
297297
<p class="card-img-top"><img src="images/logo.png" style="height: 150px;" class="thumbnail-image card-img"/></p>
@@ -319,7 +319,7 @@ <h5 class="no-anchor card-title listing-title">
319319
</div>
320320
</a>
321321
</div>
322-
<div class="g-col-1" data-index="2" data-categories="LLMs and data" data-listing-date-sort="1697241600000" data-listing-file-modified-sort="1709657790544" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="4" data-listing-word-count-sort="725">
322+
<div class="g-col-1" data-index="2" data-categories="LLMs and data" data-listing-date-sort="1697241600000" data-listing-file-modified-sort="1709659178641" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="4" data-listing-word-count-sort="725">
323323
<a href="./posts/llms-and-data-pt2/index.html" class="quarto-grid-link">
324324
<div class="quarto-grid-item card h-100 card-left">
325325
<p class="card-img-top"><img src="images/logo.png" style="height: 150px;" class="thumbnail-image card-img"/></p>
@@ -347,7 +347,7 @@ <h5 class="no-anchor card-title listing-title">
347347
</div>
348348
</a>
349349
</div>
350-
<div class="g-col-1" data-index="3" data-categories="LLMs and data" data-listing-date-sort="1697155200000" data-listing-file-modified-sort="1709657790544" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="7" data-listing-word-count-sort="1298">
350+
<div class="g-col-1" data-index="3" data-categories="LLMs and data" data-listing-date-sort="1697155200000" data-listing-file-modified-sort="1709659178641" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="7" data-listing-word-count-sort="1298">
351351
<a href="./posts/llms-and-data-pt1/index.html" class="quarto-grid-link">
352352
<div class="quarto-grid-item card h-100 card-left">
353353
<p class="card-img-top"><img src="images/logo.png" style="height: 150px;" class="thumbnail-image card-img"/></p>
@@ -375,7 +375,7 @@ <h5 class="no-anchor card-title listing-title">
375375
</div>
376376
</a>
377377
</div>
378-
<div class="g-col-1" data-index="4" data-categories="LLMs and data" data-listing-date-sort="1697068800000" data-listing-file-modified-sort="1709657790544" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="822">
378+
<div class="g-col-1" data-index="4" data-categories="LLMs and data" data-listing-date-sort="1697068800000" data-listing-file-modified-sort="1709659178641" data-listing-date-modified-sort="NaN" data-listing-reading-time-sort="5" data-listing-word-count-sort="822">
379379
<a href="./posts/llms-and-data-pt0/index.html" class="quarto-grid-link">
380380
<div class="quarto-grid-item card h-100 card-left">
381381
<p class="card-img-top"><img src="images/logo.png" style="height: 150px;" class="thumbnail-image card-img"/></p>

0 commit comments

Comments
 (0)