Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

Add documentation redirects to fix legacy /docs/* URLs (#1681)

sushmanth reddyf8763e43998a
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 5491bd696..afd9e267f 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -129,12 +129,97 @@ plugins:
- redirects:
redirect_maps:
'index.md': 'intro.md'
+ # Intro page redirects
+ 'docs/intro.md': 'intro.md'
+ 'docs/intro/index.md': 'intro.md'
+
+
+ # Quick Start redirects
+ 'docs/quick-start/installation.md': 'quick-start/installation.md'
+ 'docs/quick-start/getting-started-01.md': 'quick-start/getting-started-01.md'
+ 'docs/quick-start/getting-started-02.md': 'quick-start/getting-started-02.md'
+
+ # Building Blocks redirects
+ 'docs/building-blocks/solving_your_task.md': 'building-blocks/solving_your_task.md'
+ 'docs/building-blocks/1-language_models.md': 'building-blocks/1-language_models.md'
+ 'docs/building-blocks/2-signatures.md': 'building-blocks/2-signatures.md'
+ 'docs/building-blocks/3-modules.md': 'building-blocks/3-modules.md'
+ 'docs/building-blocks/4-data.md': 'building-blocks/4-data.md'
+ 'docs/building-blocks/5-metrics.md': 'building-blocks/5-metrics.md'
+ 'docs/building-blocks/6-optimizers.md': 'building-blocks/6-optimizers.md'
+ 'docs/building-blocks/7-assertions.md': 'building-blocks/7-assertions.md'
+ 'docs/building-blocks/8-typed_predictors.md': 'building-blocks/8-typed_predictors.md'
+
+ # Tutorials redirects
'docs/tutorials/rag.md': 'tutorials/rag.md'
'docs/tutorials/simplified-baleen.md': 'tutorials/simplified-baleen.md'
'docs/tutorials/summarization.md': 'tutorials/summarization.md'
'docs/tutorials/other_tutorial.md': 'tutorials/other_tutorial.md'
'docs/tutorials/examples.md': 'tutorials/examples.md'
+ # Deep Dive redirects
+ # Data Handling
+ 'docs/deep-dive/data-handling/examples.md': 'deep-dive/data-handling/examples.md'
+ 'docs/deep-dive/data-handling/built-in-datasets.md': 'deep-dive/data-handling/built-in-datasets.md'
+ 'docs/deep-dive/data-handling/loading-custom-data.md': 'deep-dive/data-handling/loading-custom-data.md'
+
+ # Signatures
+ 'docs/deep-dive/signature/understanding-signatures.md': 'deep-dive/signature/understanding-signatures.md'
+ 'docs/deep-dive/signature/executing-signatures.md': 'deep-dive/signature/executing-signatures.md'
+
+ # Modules
+ 'docs/deep-dive/modules/predict.md': 'deep-dive/modules/predict.md'
+ 'docs/deep-dive/modules/chain-of-thought.md': 'deep-dive/modules/chain-of-thought.md'
+ 'docs/deep-dive/modules/chain-of-thought-with-hint.md': 'deep-dive/modules/chain-of-thought-with-hint.md'
+ 'docs/deep-dive/modules/react.md': 'deep-dive/modules/react.md'
+ 'docs/deep-dive/modules/multi-chain-comparison.md': 'deep-dive/modules/multi-chain-comparison.md'
+ 'docs/deep-dive/modules/program-of-thought.md': 'deep-dive/modules/program-of-thought.md'
+ 'docs/deep-dive/modules/assertions.md': 'deep-dive/modules/assertions.md'
+ 'docs/deep-dive/modules/retrieve.md': 'deep-dive/modules/retrieve.md'
+ 'docs/deep-dive/modules/guide.md': 'deep-dive/modules/guide.md'
+
+ # Language Model Clients
+ 'docs/deep-dive/language_model_clients/lm_local_models/HFClientTGI.md': 'deep-dive/language_model_clients/lm_local_models/HFClientTGI.md'
+ 'docs/deep-dive/language_model_clients/lm_local_models/HFClientVLLM.md': 'deep-dive/language_model_clients/lm_local_models/HFClientVLLM.md'
+ 'docs/deep-dive/language_model_clients/lm_local_models/MLC.md': 'deep-dive/language_model_clients/lm_local_models/MLC.md'
+ 'docs/deep-dive/language_model_clients/lm_local_models/Ollama.md': 'deep-dive/language_model_clients/lm_local_models/Ollama.md'
+ 'docs/deep-dive/language_model_clients/lm_local_models/LlamaCpp.md': 'deep-dive/language_model_clients/lm_local_models/LlamaCpp.md'
+ 'docs/deep-dive/language_model_clients/lm_local_models/TensorRTLLM.md': 'deep-dive/language_model_clients/lm_local_models/TensorRTLLM.md'
+
+ # Retrieval Model Clients
+ 'docs/deep-dive/retrieval_models_clients/Azure.md': 'deep-dive/retrieval_models_clients/Azure.md'
+ 'docs/deep-dive/retrieval_models_clients/ChromadbRM.md': 'deep-dive/retrieval_models_clients/ChromadbRM.md'
+ 'docs/deep-dive/retrieval_models_clients/ColBERTv2.md': 'deep-dive/retrieval_models_clients/ColBERTv2.md'
+ 'docs/deep-dive/retrieval_models_clients/custom-rm-client.md': 'deep-dive/retrieval_models_clients/custom-rm-client.md'
+ 'docs/deep-dive/retrieval_models_clients/DatabricksRM.md': 'deep-dive/retrieval_models_clients/DatabricksRM.md'
+ 'docs/deep-dive/retrieval_models_clients/FaissRM.md': 'deep-dive/retrieval_models_clients/FaissRM.md'
+ 'docs/deep-dive/retrieval_models_clients/LancedbRM.md': 'deep-dive/retrieval_models_clients/LancedbRM.md'
+ 'docs/deep-dive/retrieval_models_clients/MilvusRM.md': 'deep-dive/retrieval_models_clients/MilvusRM.md'
+ 'docs/deep-dive/retrieval_models_clients/MyScaleRM.md': 'deep-dive/retrieval_models_clients/MyScaleRM.md'
+ 'docs/deep-dive/retrieval_models_clients/Neo4jRM.md': 'deep-dive/retrieval_models_clients/Neo4jRM.md'
+ 'docs/deep-dive/retrieval_models_clients/QdrantRM.md': 'deep-dive/retrieval_models_clients/QdrantRM.md'
+ 'docs/deep-dive/retrieval_models_clients/RAGatouilleRM.md': 'deep-dive/retrieval_models_clients/RAGatouilleRM.md'
+ 'docs/deep-dive/retrieval_models_clients/SnowflakeRM.md': 'deep-dive/retrieval_models_clients/SnowflakeRM.md'
+ 'docs/deep-dive/retrieval_models_clients/WatsonDiscovery.md': 'deep-dive/retrieval_models_clients/WatsonDiscovery.md'
+ 'docs/deep-dive/retrieval_models_clients/WeaviateRM.md': 'deep-dive/retrieval_models_clients/WeaviateRM.md'
+ 'docs/deep-dive/retrieval_models_clients/YouRM.md': 'deep-dive/retrieval_models_clients/YouRM.md'
+
+ # Assertions
+ 'docs/deep-dive/assertions.md': 'deep-dive/assertions.md'
+
+ # Teleprompters
+ 'docs/deep-dive/optimizers/LabeledFewShot.md': 'deep-dive/optimizers/LabeledFewShot.md'
+ 'docs/deep-dive/optimizers/bootstrap-fewshot.md': 'deep-dive/optimizers/bootstrap-fewshot.md'
+ 'docs/deep-dive/optimizers/BootstrapFinetune.md': 'deep-dive/optimizers/BootstrapFinetune.md'
+ 'docs/deep-dive/optimizers/Ensemble.md': 'deep-dive/optimizers/Ensemble.md'
+ 'docs/deep-dive/optimizers/bfrs.md': 'deep-dive/optimizers/bfrs.md'
+ 'docs/deep-dive/optimizers/copro.md': 'deep-dive/optimizers/copro.md'
+ 'docs/deep-dive/optimizers/miprov2.md': 'deep-dive/optimizers/miprov2.md'
+
+ # Additional pages redirects
+ 'docs/faqs.md': 'faqs.md'
+ 'docs/cheatsheet.md': 'cheatsheet.md'
+ 'docs/dspy-usecases.md': 'dspy-usecases.md'
extra:
social: