From 283d977cb258a4072e750f08f18fcf3a95349337 Mon Sep 17 00:00:00 2001 From: ignorejjj <1009979434@qq.com> Date: Sun, 19 Jan 2025 13:26:59 +0800 Subject: [PATCH] update page --- docs/_sidebar.md | 21 ++++++++++++++++++--- docs/en-us/README.md | 2 +- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 435f857..9ab9812 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -14,21 +14,36 @@ * [Basic Settings](en/basic-settings.md) * [Retriever Settings](en/retriever-settings.md) * [Generator Settings](en/generator-settings.md) + * Components * [Retriever](en/retriever.md) * [Generator](en/generator.md) * [Judger](en/judger.md) * [Refiner](en/refiner.md) + * Prompt Template * [Overview](en/prompt-template.md) + * Pipelines * [Pipeline](en/pipeline.md) + * Evaluation * [Overview](en/evaluation.md) * [Evaluation Metrics](en/evaluation-metrics.md) + * Reproduce Experiments * [Results](en/results.md) * [Reproduce Process](en/reproduce-process.md) -* FAQs - * [Overview](en/faqs.md) - * [FAQ](en/faq.md) + +* Api Reference + * [flashrag.config](en/flashrag.config.md) + * [flashrag.dataset](en/flashrag.dataset.md) + * [flashrag.evaluator](en/flashrag.evaluator.md) + * [flashrag.prompt](en/flashrag.prompt.md) + * [flashrag.utils](en/flashrag.utils.md) + * [flashrag.retriever](en/flashrag.retriever.md) + * [flashrag.generator](en/flashrag.generator.md) + * [flashrag.judger](en/flashrag.judger.md) + * [flashrag.refiner](en/flashrag.refiner.md) + * [flashrag.pipeline](en/flashrag.pipeline.md) + diff --git a/docs/en-us/README.md b/docs/en-us/README.md index abd0b8e..2085196 100644 --- a/docs/en-us/README.md +++ b/docs/en-us/README.md @@ -1,6 +1,6 @@ # Welcome to FlashRAG's documentation! -![](./asset/framework.jpg) +![](asset/framework.jpg) # Introduction