Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
souzatharsis committed Nov 20, 2024
1 parent 5c66149 commit af9cab7
Show file tree
Hide file tree
Showing 13 changed files with 25 additions and 27 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
![Taming Language Models Logo](tamingllms/_static/logo.png)


https://www.souzatharsis.com/tamingLLMs

# Taming Language Models: A Practical Guide to LLM Pitfalls with Python Examples

In recent years, Large Language Models (LLMs) have emerged as a transformative force in technology, promising to revolutionize how we build products and interact with computers. From ChatGPT to GitHub Copilot and Claude Artifacts, these systems have captured the public imagination and sparked a gold rush of AI-powered applications. However, beneath the surface of this technological revolution lies a complex landscape of challenges that practitioners must navigate.
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.
2 changes: 1 addition & 1 deletion tamingllms/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: faaddf3eabdcec962a96065322b5161f
config: fb7008fb19a6763c1f393b638a839515
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 0 additions & 2 deletions tamingllms/_build/html/_sources/markdown/toc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Taming Language Models: A Practical Guide to LLM Pitfalls

## Chapter 1: Introduction
- The Hidden Challenges of LLMs
- Why This Book Matters
Expand Down
Binary file modified tamingllms/_build/html/_static/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions tamingllms/_build/html/markdown/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="Non-determinism" href="../notebooks/nondeterminism.html" />
<link rel="prev" title="Taming Language Models: A Practical Guide to LLM Pitfalls" href="toc.html" />
<link rel="prev" title="Chapter 1: Introduction" href="toc.html" />
<meta name="mobile-web-app-capable" content="yes">
<meta name="apple-mobile-web-app-capable" content="yes">
</head><body>
Expand Down Expand Up @@ -101,7 +101,7 @@
</div>
</header>
<nav>
<a href="toc.html" class="nav-icon previous" title="previous:&#13;Taming Language Models: A Practical Guide to LLM Pitfalls" aria-label="Previous topic" accesskey="P" tabindex="-1">
<a href="toc.html" class="nav-icon previous" title="previous:&#13;Chapter 1: Introduction" aria-label="Previous topic" accesskey="P" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M31.7 239l136-136c9.4-9.4 24.6-9.4 33.9 0l22.6 22.6c9.4 9.4 9.4 24.6 0 33.9L127.9 256l96.4 96.4c9.4 9.4 9.4 24.6 0 33.9L201.7 409c-9.4 9.4-24.6 9.4-33.9 0l-136-136c-9.5-9.4-9.5-24.6-.1-34z"/></svg>
</a>
<a href="../notebooks/nondeterminism.html" class="nav-icon next" title="next:&#13;Non-determinism" aria-label="Next topic" accesskey="N" tabindex="-1">
Expand All @@ -117,7 +117,7 @@
<div class="title">
<span class="text">
<span class="direction">previous</span>
Taming Language Models: A Practical Guide to LLM Pitfalls
Chapter 1: Introduction
</span>
</div>
</a>
Expand Down Expand Up @@ -306,7 +306,7 @@ <h3><a href="toc.html">Table of Contents</a></h3>
<div class="title">
<span class="text">
<span class="direction">previous</span>
Taming Language Models: A Practical Guide to LLM Pitfalls
Chapter 1: Introduction
</span>
</div>
</a>
Expand Down
27 changes: 12 additions & 15 deletions tamingllms/_build/html/markdown/toc.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<title>Taming Language Models: A Practical Guide to LLM Pitfalls &#8212; Taming Language Models: A Practical Guide to LLM Pitfalls with Python Examples</title>
<title>Chapter 1: Introduction &#8212; Taming Language Models: A Practical Guide to LLM Pitfalls with Python Examples</title>
<link rel="stylesheet" href="../_static/basic.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="../_static/insipid.css" />
Expand Down Expand Up @@ -78,7 +78,7 @@
</div>
<div class="title">
<span class="parent">Taming Language Models: A Practical Guide to LLM Pitfalls with Python Examples</span>
<a class="top" href="#">Taming Language Models: A Practical Guide to LLM Pitfalls</a>
<a class="top" href="#">Chapter 1: Introduction</a>
</div>
<div class="buttons">
<button id="fullscreen-button" type="button" aria-hidden="true">
Expand Down Expand Up @@ -124,18 +124,16 @@
<div class="bodywrapper">
<div class="body" role="main">

<section class="tex2jax_ignore mathjax_ignore" id="taming-language-models-a-practical-guide-to-llm-pitfalls">
<h1>Taming Language Models: A Practical Guide to LLM Pitfalls<a class="headerlink" href="#taming-language-models-a-practical-guide-to-llm-pitfalls" title="Permalink to this heading"></a></h1>
<section id="chapter-1-introduction">
<h2>Chapter 1: Introduction<a class="headerlink" href="#chapter-1-introduction" title="Permalink to this heading"></a></h2>
<h1>Chapter 1: Introduction<a class="headerlink" href="#chapter-1-introduction" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>The Hidden Challenges of LLMs</p></li>
<li><p>Why This Book Matters</p></li>
<li><p>Overview of Key Problems</p></li>
</ul>
</section>
<section id="chapter-2-non-determinism-evals">
<h2>Chapter 2: Non-determinism &amp; Evals<a class="headerlink" href="#chapter-2-non-determinism-evals" title="Permalink to this heading"></a></h2>
<h1>Chapter 2: Non-determinism &amp; Evals<a class="headerlink" href="#chapter-2-non-determinism-evals" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>Understanding Non-deterministic Behavior in LLMs</p></li>
<li><p>Temperature and Randomness Effects</p></li>
Expand All @@ -161,7 +159,7 @@ <h2>Chapter 2: Non-determinism &amp; Evals<a class="headerlink" href="#chapter-2
</ul>
</section>
<section id="chapter-3-wrestling-with-structured-output">
<h2>Chapter 3: Wrestling with Structured Output<a class="headerlink" href="#chapter-3-wrestling-with-structured-output" title="Permalink to this heading"></a></h2>
<h1>Chapter 3: Wrestling with Structured Output<a class="headerlink" href="#chapter-3-wrestling-with-structured-output" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>The Structured Output Challenge</p></li>
<li><p>Common Failure Modes</p></li>
Expand All @@ -178,7 +176,7 @@ <h2>Chapter 3: Wrestling with Structured Output<a class="headerlink" href="#chap
</ul>
</section>
<section id="chapter-4-hallucination-the-reality-gap">
<h2>Chapter 4: Hallucination: The Reality Gap<a class="headerlink" href="#chapter-4-hallucination-the-reality-gap" title="Permalink to this heading"></a></h2>
<h1>Chapter 4: Hallucination: The Reality Gap<a class="headerlink" href="#chapter-4-hallucination-the-reality-gap" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>Understanding Hallucination Types</p></li>
<li><p>Detection Strategies</p></li>
Expand All @@ -200,7 +198,7 @@ <h2>Chapter 4: Hallucination: The Reality Gap<a class="headerlink" href="#chapte
</ul>
</section>
<section id="chapter-5-the-cost-factor">
<h2>Chapter 5: The Cost Factor<a class="headerlink" href="#chapter-5-the-cost-factor" title="Permalink to this heading"></a></h2>
<h1>Chapter 5: The Cost Factor<a class="headerlink" href="#chapter-5-the-cost-factor" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>Understanding LLM Costs</p></li>
<li><p>Token Optimization</p></li>
Expand All @@ -216,7 +214,7 @@ <h2>Chapter 5: The Cost Factor<a class="headerlink" href="#chapter-5-the-cost-fa
</ul>
</section>
<section id="chapter-6-safety-concerns">
<h2>Chapter 6: Safety Concerns<a class="headerlink" href="#chapter-6-safety-concerns" title="Permalink to this heading"></a></h2>
<h1>Chapter 6: Safety Concerns<a class="headerlink" href="#chapter-6-safety-concerns" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>Common Safety Issues</p></li>
<li><p>Implementation of Safety Guards</p></li>
Expand All @@ -228,7 +226,7 @@ <h2>Chapter 6: Safety Concerns<a class="headerlink" href="#chapter-6-safety-conc
</ul>
</section>
<section id="chapter-7-size-and-length-limitations">
<h2>Chapter 7: Size and Length Limitations<a class="headerlink" href="#chapter-7-size-and-length-limitations" title="Permalink to this heading"></a></h2>
<h1>Chapter 7: Size and Length Limitations<a class="headerlink" href="#chapter-7-size-and-length-limitations" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>Context Window Constraints</p></li>
<li><p>Handling Long Inputs</p></li>
Expand All @@ -239,7 +237,7 @@ <h2>Chapter 7: Size and Length Limitations<a class="headerlink" href="#chapter-7
</ul>
</section>
<section id="chapter-8-breaking-free-from-cloud-providers">
<h2>Chapter 8: Breaking Free from Cloud Providers<a class="headerlink" href="#chapter-8-breaking-free-from-cloud-providers" title="Permalink to this heading"></a></h2>
<h1>Chapter 8: Breaking Free from Cloud Providers<a class="headerlink" href="#chapter-8-breaking-free-from-cloud-providers" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>The Vendor Lock-in Problem</p></li>
<li><p>Self-hosting Solutions</p>
Expand All @@ -255,7 +253,7 @@ <h2>Chapter 8: Breaking Free from Cloud Providers<a class="headerlink" href="#ch
</ul>
</section>
<section id="appendix-a-code-examples">
<h2>Appendix A: Code Examples<a class="headerlink" href="#appendix-a-code-examples" title="Permalink to this heading"></a></h2>
<h1>Appendix A: Code Examples<a class="headerlink" href="#appendix-a-code-examples" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>Complete Implementation Examples</p></li>
<li><p>Testing Scripts</p></li>
Expand All @@ -264,14 +262,13 @@ <h2>Appendix A: Code Examples<a class="headerlink" href="#appendix-a-code-exampl
</ul>
</section>
<section id="appendix-b-tools-and-resources">
<h2>Appendix B: Tools and Resources<a class="headerlink" href="#appendix-b-tools-and-resources" title="Permalink to this heading"></a></h2>
<h1>Appendix B: Tools and Resources<a class="headerlink" href="#appendix-b-tools-and-resources" title="Permalink to this heading"></a></h1>
<ul class="simple">
<li><p>Recommended Libraries</p></li>
<li><p>Testing Tools</p></li>
<li><p>Monitoring Solutions</p></li>
<li><p>Community Resources</p></li>
</ul>
</section>
<div class="toctree-wrapper compound">
</div>
</section>
Expand Down
Binary file modified tamingllms/_build/html/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion tamingllms/_build/html/searchindex.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions tamingllms/_config.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html

title: "Taming Language Models: A Practical Guide to LLM Pitfalls with Python Examples"
title: "Taming Large Language Models: A Practical Guide to LLM Pitfalls with Python Examples"
author: Tharsis T. P. Souza
copyright: "2024" # Copyright year to be placed in the footer
logo: images/logo.png
logo: _static/logo.png


# Force re-execution of notebooks on each build.
Expand Down
Binary file modified tamingllms/_static/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 0 additions & 2 deletions tamingllms/markdown/toc.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Taming Language Models: A Practical Guide to LLM Pitfalls

## Chapter 1: Introduction
- The Hidden Challenges of LLMs
- Why This Book Matters
Expand Down

0 comments on commit af9cab7

Please sign in to comment.