From 74bcd43bf75b89fa91e0a73d8c755770d164b5b3 Mon Sep 17 00:00:00 2001 From: daavoo Date: Thu, 12 Dec 2024 12:29:42 +0100 Subject: [PATCH] Add api examples --- docs/step-by-step-guide.md | 37 +++++++++++++++++++++++++++++++++++++ mkdocs.yml | 2 ++ 2 files changed, 39 insertions(+) diff --git a/docs/step-by-step-guide.md b/docs/step-by-step-guide.md index 3fa0bc0..2ed8927 100644 --- a/docs/step-by-step-guide.md +++ b/docs/step-by-step-guide.md @@ -48,6 +48,33 @@ Cleaner input data ensures that the model works with reliable and consistent inf - Ensures the document is clean and ready for the next step. +### 🔍 **API Example** + +```py +from document_to_podcast.preprocessing import DATA_CLEANERS, DATA_LOADERS + +input_file = "example_data/introducing-mozilla-ai-investing-in-trustworthy-ai.html" +data_loader = DATA_LOADERS[".html"] +data_cleaner = DATA_CLEANERS[".html"] + +raw_data = data_loader(input_file) +print(raw_data[:200]) +""" + + + + + + +