Skip to content

Commit

Permalink
(doc): Add issue_classification_user_journe.ipynb to README.
Browse files Browse the repository at this point in the history
Task: IL-427
  • Loading branch information
SebastianNiehusAA committed Apr 10, 2024
1 parent cc97810 commit cfd9e06
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## Unreleased

- Documentation
- fix: Add missing link to `issue_classification_user_journey` notebook to the tutorials section of README.

## 0.8.1

### Fixes
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,11 +196,13 @@ The tutorials aim to guide you through implementing several common use-cases wit
| 2 | Question Answering | Various approaches for QA | [qa.ipynb](./src/examples/qa.ipynb) |
| 3 | Classification | Learn about two methods of classification | [classification.ipynb](./src/examples/classification.ipynb) |
| 4 | Evaluation | Evaluate LLM-based methodologies | [evaluation.ipynb](./src/examples/evaluation.ipynb) |
| 5 | Quickstart Task | Build a custom `Task` for your use case | [quickstart_task.ipynb](./src/examples/quickstart_task.ipynb) |
| 6 | Document Index | Connect your proprietary knowledge base | [document_index.ipynb](./src/examples/document_index.ipynb) |
| 7 | Human Evaluation | Connect to Argilla for manual evaluation | [human_evaluation.ipynb](./src/examples/human_evaluation.ipynb) |
| 8 | Performance tips | Contains some small tips for performance | [performance_tips.ipynb](./src/examples/performance_tips.ipynb) |
| 9 | Deployment | Shows how to deploy a Task in a minimal FastAPI app. | [fastapi_tutorial.md](./src/examples/fastapi_tutorial.md) |
| 5 | Issue Classification | In-depth tutorial about implementing and evaluating an email classificator | [issue_classification_user_journy.ipynb](./src/examples/issue_classification_user_journey.ipynb)
| 6 | Quickstart Task | Build a custom `Task` for your use case | [quickstart_task.ipynb](./src/examples/quickstart_task.ipynb) |
| 7 | Document Index | Connect your proprietary knowledge base | [document_index.ipynb](./src/examples/document_index.ipynb) |
| 8 | Human Evaluation | Connect to Argilla for manual evaluation | [human_evaluation.ipynb](./src/examples/human_evaluation.ipynb) |
| 9 | Performance tips | Contains some small tips for performance | [performance_tips.ipynb](./src/examples/performance_tips.ipynb) |
| 10 | Deployment | Shows how to deploy a Task in a minimal FastAPI app. | [fastapi_tutorial.md](./src/examples/fastapi_tutorial.md) |


## How-Tos
The how-tos are quick lookups about how to do things. Compared to the tutorials, they are shorter and do not explain the concepts they are using in-depth.
Expand Down

0 comments on commit cfd9e06

Please sign in to comment.