Skip to content

Commit

Permalink
update toc
Browse files Browse the repository at this point in the history
  • Loading branch information
souzatharsis committed Dec 24, 2024
1 parent d5d6785 commit ea6ac65
Show file tree
Hide file tree
Showing 31 changed files with 46 additions and 43 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ By understanding these pitfalls upfront, readers will be better equipped to buil
| About the Book | [html](https://www.souzatharsis.com/tamingLLMs/markdown/intro.html) | N/A | *Ready for Review* |
| Chapter 1: Wrestling with Structured Output| [html](https://www.souzatharsis.com/tamingLLMs/notebooks/structured_output.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/structured_output.ipynb) | *Ready for Review* |
| Chapter 2: The Input Data Challenge | | | |
| Chapter 3: Output Size Limitations | [html](https://www.souzatharsis.com/tamingLLMs/notebooks/output_size_limit.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/output_size_limit.ipynb) | *Ready for Review* |
| Chapter 3: Output Size Limitations | [html](https://www.souzatharsis.com/tamingLLMs/notebooks/output_size_limit.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/output_size_limit.ipynb) | WIP |
| Chapter 4: The Evals Gap | [html](https://www.souzatharsis.com/tamingLLMs/notebooks/evals.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/evals.ipynb) | *Ready for Review* |
| Chapter 5: Safety Concerns | [html](https://www.souzatharsis.com/tamingLLMs/notebooks/safety.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/safety.ipynb) | *Ready for Review* |
| Chapter 6: Preference-Based Alignment | [html](https://www.souzatharsis.com/tamingLLMs/notebooks/alignment.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/alignment.ipynb) | *Ready for Review* |
| Chapter 7: Breaking Free from Cloud-Based Models | [html](https://www.souzatharsis.com/tamingLLMs/notebooks/local.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/local.ipynb) | *Ready for Review* |
| Chapter 7: Local LLMs in Practice | [html](https://www.souzatharsis.com/tamingLLMs/notebooks/local.html) | [ipynb](https://github.com/souzatharsis/tamingLLMs/blob/master/tamingllms/notebooks/local.ipynb) | *Ready for Review* |
| Chapter 8: The Cost Factor | | | |
| Chapter 9: Frontiers | | | WIP |
| Appendix A: Tools and Resources | | | |
Expand Down
Binary file modified tamingllms/_build/.doctrees/environment.pickle
Binary file not shown.
Binary file modified tamingllms/_build/.doctrees/markdown/toc.doctree
Binary file not shown.
Binary file modified tamingllms/_build/.doctrees/notebooks/alignment.doctree
Binary file not shown.
Binary file modified tamingllms/_build/.doctrees/notebooks/local.doctree
Binary file not shown.
Binary file modified tamingllms/_build/.doctrees/notebooks/safety.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion tamingllms/_build/html/_sources/markdown/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Abstract: *The current discourse around Large Language Models (LLMs) tends to fo

## [Chapter 6: Preference-based Alignment](https://www.souzatharsis.com/tamingLLMs/notebooks/alignment.html)

## [Chapter 7: Breaking Free from Proprietary Models](https://www.souzatharsis.com/tamingLLMs/notebooks/local.html)
## [Chapter 7: Local LLMs in Practice](https://www.souzatharsis.com/tamingLLMs/notebooks/local.html)

## Chapter 8: The Cost Factor

Expand Down
1 change: 1 addition & 0 deletions tamingllms/_build/html/_sources/notebooks/alignment.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"(alignment)=\n",
"# Preference-Based Alignment\n",
"```{epigraph}\n",
"A people that values its privileges above its principles soon loses both.\n",
Expand Down
4 changes: 2 additions & 2 deletions tamingllms/_build/html/_sources/notebooks/local.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Breaking Free from Proprietary Models\n",
"# Local LLMs in Practice\n",
"```{epigraph}\n",
"Freedom is something that dies unless it's used.\n",
"\n",
Expand Down Expand Up @@ -1364,7 +1364,7 @@
" author = {Tharsis T. P. Souza},\n",
" title = {Taming LLMs: A Practical Guide to LLM Pitfalls with Open Source Software},\n",
" year = {2024},\n",
" chapter = {Breaking Free from Cloud Providers},\n",
" chapter = {Local LLMs in Practice},\n",
" journal = {GitHub repository},\n",
" url = {https://github.com/souzatharsis/tamingLLMs)\n",
"}\n",
Expand Down
4 changes: 2 additions & 2 deletions tamingllms/_build/html/_sources/notebooks/safety.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1178,7 +1178,7 @@
"IBM Granite Guardian performance is superior compared to Llama-Guard and ShieldGemma model families for the \"Harm\" risk dimension {cite}`padhi2024graniteguardian`.\n",
"```\n",
"\n",
"The industry is increasingly focusing on the fine-tuning of pre-trained base models targeting a specific dimension of requirements and standards, here Safety being a critical one. This trend encompasses the release of open-source, fine-tuned safety models that can act as protective guardrails for LLM applications, as exemplified by LLaMa-Guard and IBM Granite Guardian. Additionally, there is a notable rise in models fine-tuned through techniques such as Reinforcement Learning from Human Feedback (RLHF), utilizing human preference datasets that incorporate safety considerations. These specialized models can function as safety filters as discussed but also as main models that alone could accomplished their original intended task but safely. We will cover this specific topic of preference-based alignment in the [next chapter](https://www.souzatharsis.com/tamingLLMs/notebooks/alignment.html), where we will explore the process of aligning language models with human preferences ultimately leading to the development of an open source fine-tuned model that complies with user provided policy-based requirements."
"The industry is increasingly focusing on the fine-tuning of pre-trained base models targeting a specific dimension of requirements and standards, here Safety being a critical one. This trend encompasses the release of open-source, fine-tuned safety models that can act as protective guardrails for LLM applications, as exemplified by LLaMa-Guard and IBM Granite Guardian. Additionally, there is a notable rise in models fine-tuned through techniques such as Reinforcement Learning from Human Feedback (RLHF), utilizing human preference datasets that incorporate safety considerations. These specialized models can function as safety filters as discussed but also as main models that alone could accomplished their original intended task but safely. We will cover this specific topic of preference-based alignment in the next Chapter {ref}`alignment`, where we will explore the process of aligning language models with human preferences ultimately leading to the development of an open source fine-tuned model that complies with user provided policy-based requirements."
]
},
{
Expand Down Expand Up @@ -1305,7 +1305,7 @@
"- Scoring system: The prompt employs a scoring mechanism that quantifies content severity on a scale from 0 to 1, allowing for nuanced assessments and encouraging consideration of context.\n",
"- Transparency in decision-making: The requirement for a brief explanation of the verdict fosters transparency, helping educators and students understand the rationale behind content moderation decisions.\n",
"- Few-shot learning: Incorporating few-shot learning techniques can enhance the AI's ability to generalize from limited examples.\n",
"- Output format: Both examples and instruction specify a target output format increasing reliability of the structure of the response (see [Chapter 4. Wrestling with Structured Output](https://www.souzatharsis.com/tamingLLMs/notebooks/structured_output.html) on how to guarantee structured output).\n",
"- Output format: Both examples and instruction specify a target output format increasing reliability of the structure of the response (see Chapter {ref}`structure` on how to guarantee structured output).\n",
"\n",
"Of course, an LLM-as-a-judge filtering approach is not free of limitations, since it may add latency, cost, operational complexity and the LLM judge itself may be unsafe! We will discuss it later in the case study."
]
Expand Down
2 changes: 1 addition & 1 deletion tamingllms/_build/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@

<li class="toctree-l1 ">

<a href="notebooks/local.html" class="reference internal ">Breaking Free from Proprietary Models</a>
<a href="notebooks/local.html" class="reference internal ">Local LLMs in Practice</a>



Expand Down
2 changes: 1 addition & 1 deletion tamingllms/_build/html/markdown/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@

<li class="toctree-l1 ">

<a href="../notebooks/local.html" class="reference internal ">Breaking Free from Proprietary Models</a>
<a href="../notebooks/local.html" class="reference internal ">Local LLMs in Practice</a>



Expand Down
2 changes: 1 addition & 1 deletion tamingllms/_build/html/markdown/preface.html
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@

<li class="toctree-l1 ">

<a href="../notebooks/local.html" class="reference internal ">Breaking Free from Proprietary Models</a>
<a href="../notebooks/local.html" class="reference internal ">Local LLMs in Practice</a>



Expand Down
6 changes: 3 additions & 3 deletions tamingllms/_build/html/markdown/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@

<li class="toctree-l1 ">

<a href="../notebooks/local.html" class="reference internal ">Breaking Free from Proprietary Models</a>
<a href="../notebooks/local.html" class="reference internal ">Local LLMs in Practice</a>



Expand Down Expand Up @@ -254,8 +254,8 @@ <h2><a class="reference external" href="https://www.souzatharsis.com/tamingLLMs/
<section id="chapter-6-preference-based-alignment">
<h2><a class="reference external" href="https://www.souzatharsis.com/tamingLLMs/notebooks/alignment.html">Chapter 6: Preference-based Alignment</a><a class="headerlink" href="#chapter-6-preference-based-alignment" title="Permalink to this heading"></a></h2>
</section>
<section id="chapter-7-breaking-free-from-proprietary-models">
<h2><a class="reference external" href="https://www.souzatharsis.com/tamingLLMs/notebooks/local.html">Chapter 7: Breaking Free from Proprietary Models</a><a class="headerlink" href="#chapter-7-breaking-free-from-proprietary-models" title="Permalink to this heading"></a></h2>
<section id="chapter-7-local-llms-in-practice">
<h2><a class="reference external" href="https://www.souzatharsis.com/tamingLLMs/notebooks/local.html">Chapter 7: Local LLMs in Practice</a><a class="headerlink" href="#chapter-7-local-llms-in-practice" title="Permalink to this heading"></a></h2>
</section>
<section id="chapter-8-the-cost-factor">
<h2>Chapter 8: The Cost Factor<a class="headerlink" href="#chapter-8-the-cost-factor" title="Permalink to this heading"></a></h2>
Expand Down
10 changes: 5 additions & 5 deletions tamingllms/_build/html/notebooks/alignment.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="8. Breaking Free from Proprietary Models" href="local.html" />
<link rel="next" title="8. Local LLMs in Practice" href="local.html" />
<link rel="prev" title="6. Safety" href="safety.html" />
</head>

Expand Down Expand Up @@ -214,7 +214,7 @@

<li class="toctree-l1 ">

<a href="local.html" class="reference internal ">Breaking Free from Proprietary Models</a>
<a href="local.html" class="reference internal ">Local LLMs in Practice</a>



Expand Down Expand Up @@ -244,7 +244,7 @@
</li>
<li class="next">
<a href="local.html"
title="next chapter"><span class="section-number">8. </span>Breaking Free from Proprietary Models</a>
title="next chapter"><span class="section-number">8. </span>Local LLMs in Practice</a>
</li>
</ul>

Expand All @@ -253,7 +253,7 @@
<div class="content" role="main" v-pre>

<section class="tex2jax_ignore mathjax_ignore" id="preference-based-alignment">
<h1><a class="toc-backref" href="#id225" role="doc-backlink"><span class="section-number">7. </span>Preference-Based Alignment</a><a class="headerlink" href="#preference-based-alignment" title="Permalink to this heading"></a></h1>
<span id="alignment"></span><h1><a class="toc-backref" href="#id225" role="doc-backlink"><span class="section-number">7. </span>Preference-Based Alignment</a><a class="headerlink" href="#preference-based-alignment" title="Permalink to this heading"></a></h1>
<blockquote class="epigraph">
<div><p>A people that values its privileges above its principles soon loses both.</p>
<p class="attribution">—Dwight D. Eisenhower</p>
Expand Down Expand Up @@ -2632,7 +2632,7 @@ <h2><a class="toc-backref" href="#id253" role="doc-backlink"><span class="sectio
</li>
<li class="next">
<a href="local.html"
title="next chapter"><span class="section-number">8. </span>Breaking Free from Proprietary Models</a>
title="next chapter"><span class="section-number">8. </span>Local LLMs in Practice</a>
</li>
</ul><div class="footer" role="contentinfo">
&#169; Copyright Tharsis T. P. Souza, 2024.
Expand Down
2 changes: 1 addition & 1 deletion tamingllms/_build/html/notebooks/evals.html
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@

<li class="toctree-l1 ">

<a href="local.html" class="reference internal ">Breaking Free from Proprietary Models</a>
<a href="local.html" class="reference internal ">Local LLMs in Practice</a>



Expand Down
14 changes: 7 additions & 7 deletions tamingllms/_build/html/notebooks/local.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1"><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>8. Breaking Free from Proprietary Models</title>
<title>8. Local LLMs in Practice</title>

<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/theme.css " type="text/css" />
Expand Down Expand Up @@ -187,7 +187,7 @@

<li class="toctree-l1 current">

<a href="#" class="reference internal current">Breaking Free from Proprietary Models</a>
<a href="#" class="reference internal current">Local LLMs in Practice</a>



Expand Down Expand Up @@ -224,7 +224,7 @@
<ul class="breadcrumbs">
<li><a href="../markdown/toc.html">Docs</a> &raquo;</li>

<li><span class="section-number">8. </span>Breaking Free from Proprietary Models</li>
<li><span class="section-number">8. </span>Local LLMs in Practice</li>
</ul>


Expand All @@ -239,16 +239,16 @@
<hr>
<div class="content" role="main" v-pre>

<section class="tex2jax_ignore mathjax_ignore" id="breaking-free-from-proprietary-models">
<h1><a class="toc-backref" href="#id214" role="doc-backlink"><span class="section-number">8. </span>Breaking Free from Proprietary Models</a><a class="headerlink" href="#breaking-free-from-proprietary-models" title="Permalink to this heading"></a></h1>
<section class="tex2jax_ignore mathjax_ignore" id="local-llms-in-practice">
<h1><a class="toc-backref" href="#id214" role="doc-backlink"><span class="section-number">8. </span>Local LLMs in Practice</a><a class="headerlink" href="#local-llms-in-practice" title="Permalink to this heading"></a></h1>
<blockquote class="epigraph">
<div><p>Freedom is something that dies unless it’s used.</p>
<p class="attribution">—Hunter S. Thompson</p>
</div></blockquote>
<nav class="contents" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#breaking-free-from-proprietary-models" id="id214">Breaking Free from Proprietary Models</a></p>
<li><p><a class="reference internal" href="#local-llms-in-practice" id="id214">Local LLMs in Practice</a></p>
<ul>
<li><p><a class="reference internal" href="#introduction" id="id215">Introduction</a></p></li>
<li><p><a class="reference internal" href="#models-considerations" id="id216">Models Considerations</a></p>
Expand Down Expand Up @@ -1539,7 +1539,7 @@ <h2><a class="toc-backref" href="#id240" role="doc-backlink"><span class="sectio
<span class="n">author</span> <span class="o">=</span> <span class="p">{</span><span class="n">Tharsis</span> <span class="n">T</span><span class="o">.</span> <span class="n">P</span><span class="o">.</span> <span class="n">Souza</span><span class="p">},</span>
<span class="n">title</span> <span class="o">=</span> <span class="p">{</span><span class="n">Taming</span> <span class="n">LLMs</span><span class="p">:</span> <span class="n">A</span> <span class="n">Practical</span> <span class="n">Guide</span> <span class="n">to</span> <span class="n">LLM</span> <span class="n">Pitfalls</span> <span class="k">with</span> <span class="n">Open</span> <span class="n">Source</span> <span class="n">Software</span><span class="p">},</span>
<span class="n">year</span> <span class="o">=</span> <span class="p">{</span><span class="mi">2024</span><span class="p">},</span>
<span class="n">chapter</span> <span class="o">=</span> <span class="p">{</span><span class="n">Breaking</span> <span class="n">Free</span> <span class="kn">from</span> <span class="nn">Cloud</span> <span class="n">Providers</span><span class="p">},</span>
<span class="n">chapter</span> <span class="o">=</span> <span class="p">{</span><span class="n">Local</span> <span class="n">LLMs</span> <span class="ow">in</span> <span class="n">Practice</span><span class="p">},</span>
<span class="n">journal</span> <span class="o">=</span> <span class="p">{</span><span class="n">GitHub</span> <span class="n">repository</span><span class="p">},</span>
<span class="n">url</span> <span class="o">=</span> <span class="p">{</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">souzatharsis</span><span class="o">/</span><span class="n">tamingLLMs</span><span class="p">)</span>
<span class="p">}</span>
Expand Down
2 changes: 1 addition & 1 deletion tamingllms/_build/html/notebooks/output_size_limit.html
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@

<li class="toctree-l1 ">

<a href="local.html" class="reference internal ">Breaking Free from Proprietary Models</a>
<a href="local.html" class="reference internal ">Local LLMs in Practice</a>



Expand Down
Loading

0 comments on commit ea6ac65

Please sign in to comment.