From 03363f152e132ea7f9f38b4b462fee9135e864a6 Mon Sep 17 00:00:00 2001 From: Jason Liu Date: Wed, 15 Nov 2023 19:54:12 -0500 Subject: [PATCH] clean up blog index --- docs/blog/index.md | 18 ++++++++++++++++++ docs/blog/posts/chain-of-density.md | 2 +- mkdocs.yml | 8 ++++++++ requirements-doc.txt | 3 ++- 4 files changed, 29 insertions(+), 2 deletions(-) diff --git a/docs/blog/index.md b/docs/blog/index.md index e69de29..5058819 100644 --- a/docs/blog/index.md +++ b/docs/blog/index.md @@ -0,0 +1,18 @@ +# Welcome to the Instructor Blog + +The goal of the blog is to capture some content that does not neatly fit within documentation or the cookbooks. + +## Advanced Topics + +- [Query Understanding and Expansion for RAG](posts/rag-and-beyond.md) +- [GPT-4 Level summarization with GPT3.5 Finetuning](posts/chain-of-density.md) +- [Deepdive on LLM Guardrails / Validation](posts/validation-part1.md) +- [A Guide to Fine-Tuning and Distillation](posts/distilation-part1.md) + +## Learning Python + +- [Understanding Batch Processing with async](posts/learn-async.md) + +## Talks + +- [AI Engineering Summit 2023](posts/aisummit-2023.md) diff --git a/docs/blog/posts/chain-of-density.md b/docs/blog/posts/chain-of-density.md index 864c760..bcb406d 100644 --- a/docs/blog/posts/chain-of-density.md +++ b/docs/blog/posts/chain-of-density.md @@ -470,7 +470,7 @@ instructor jobs create-from-file generated.jsonl ??? notes "Finetuning Reference" - Checking out our [Finetuning CLI](/instructor/cli/finetune/) to learn about other hyperparameters that you can tune to improve your model's performance. + Checking out our [Finetuning CLI](cli/finetune/) to learn about other hyperparameters that you can tune to improve your model's performance. Once the job is complete, all we need to do is to then change the annotation in the function call to `distil_summarization` in our original file above to start using our new model. diff --git a/mkdocs.yml b/mkdocs.yml index 40ae12e..bfaa2ec 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -177,6 +177,14 @@ plugins: post_date_format: yyyy/MM/dd post_url_format: "{date}/{slug}" authors_file: "{blog}/.authors.yml" + - rss: + match_path: blog/posts/.* + date_from_meta: + as_creation: date + categories: + - categories + - tags + enabled: !ENV [CI, false] extra: analytics: provider: google diff --git a/requirements-doc.txt b/requirements-doc.txt index b03ccb9..dc65fbe 100644 --- a/requirements-doc.txt +++ b/requirements-doc.txt @@ -9,4 +9,5 @@ pytest aiohttp==3.8.2 yarl==1.8.1 frozenlist==1.3.1 -mkdocs-minify-plugin \ No newline at end of file +mkdocs-minify-plugin +mkdocs-rss-plugin \ No newline at end of file