From 10aaf801251c19b827d26263077fefe7d8fdcbeb Mon Sep 17 00:00:00 2001 From: Jeremy Howard Date: Thu, 2 May 2024 08:47:14 +1000 Subject: [PATCH] docs --- README.md | 15 ++++++++++++++- index.ipynb | 5 ++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d68150..082d598 100644 --- a/README.md +++ b/README.md @@ -35,7 +35,20 @@ Claude API before, you should be able to read the source code. Click to read it, or clone the git repo and execute the notebook yourself to see every step of the creation process in action. The tutorial below includes links to API details which will take you to relevant parts of -the source. +the source. The reason this project is a new kind of literal program is +because we take seriously Knuth’s call to action, that we have a “*moral +commitment*” to never write an “*illiterate program*” – and so we have a +commitment to making literate programming and easy and pleasant +experience. (For more on this, see [this +talk](https://www.youtube.com/watch?v=rX1yGxJijsI) from Hamel Husain + +> “*Let us change our traditional attitude to the construction of +> programs: Instead of imagining that our main task is to instruct a +> **computer** what to do, let us concentrate rather on explaining to +> **human beings** what we want a computer to do.*” Donald E. Knuth, +> [Literate +> Programming](https://www.cs.tufts.edu/~nr/cs257/archive/literate-programming/01-knuth-lp.pdf) +> (1984) ## Install diff --git a/index.ipynb b/index.ipynb index 59fe792..19221db 100644 --- a/index.ipynb +++ b/index.ipynb @@ -18,6 +18,7 @@ "outputs": [], "source": [ "#| hide\n", + "\n", "from nbdev import show_doc\n", "from fastcore.utils import *\n", "from IPython import display" @@ -41,7 +42,9 @@ "\n", "You'll need to set the `ANTHROPIC_API_KEY` environment variable to the key provided to you by Anthropic in order to use this library.\n", "\n", - "Note that this library is the first ever \"literate nbdev\" project. That means that the actual source code for the library is a rendered Jupyter Notebook which includes callout notes and tips, HTML tables and images, detailed explanations, and teaches *how* and *why* the code is written the way it is. Even if you've never used the Anthropic Python SDK or Claude API before, you should be able to read the source code. Click [Claudette's Source](https://answerdotai.github.io/claudette/core.html) to read it, or clone the git repo and execute the notebook yourself to see every step of the creation process in action. The tutorial below includes links to API details which will take you to relevant parts of the source." + "Note that this library is the first ever \"literate nbdev\" project. That means that the actual source code for the library is a rendered Jupyter Notebook which includes callout notes and tips, HTML tables and images, detailed explanations, and teaches *how* and *why* the code is written the way it is. Even if you've never used the Anthropic Python SDK or Claude API before, you should be able to read the source code. Click [Claudette's Source](https://answerdotai.github.io/claudette/core.html) to read it, or clone the git repo and execute the notebook yourself to see every step of the creation process in action. The tutorial below includes links to API details which will take you to relevant parts of the source. The reason this project is a new kind of literal program is because we take seriously Knuth's call to action, that we have a \"*moral commitment*\" to never write an \"*illiterate program*\" -- and so we have a commitment to making literate programming and easy and pleasant experience. (For more on this, see [this talk](https://www.youtube.com/watch?v=rX1yGxJijsI) from Hamel Husain\n", + "\n", + "> \"*Let us change our traditional attitude to the construction of programs: Instead of imagining that our main task is to instruct a **computer** what to do, let us concentrate rather on explaining to **human beings** what we want a computer to do.*\" Donald E. Knuth, [Literate Programming](https://www.cs.tufts.edu/~nr/cs257/archive/literate-programming/01-knuth-lp.pdf) (1984)" ] }, {