diff --git a/docs/community/community.md b/docs/community/community.md index a053e1c9..7210c66e 100644 --- a/docs/community/community.md +++ b/docs/community/community.md @@ -1,7 +1,7 @@ --- layout: default title: Community -nav_order: 5 +nav_order: 6 has_children: true description: community resources, getting help and sharing ideas permalink: /community @@ -9,7 +9,15 @@ permalink: /community # Community -COMING SOON ... +Welcome to the llmware community! We are on a mission to pioneer the use of small language models as transformational tools +in the enterprise to automate workflows and knowledge-based processes cost-effectively, securely and with high quality. We believe that the +secret is increasing out that small models can be extremely effective, but require a lot of attention to detail in building scalable data pipelines +and fine-tuning both models and end-to-end workflows. + +We are open to both the most advanced machine learning researchers and the beginning developer just learning python. + +We publish a wide range of examples, use cases and tutorial videos, and are always looking for feedback, new ideas and contributors. + {: .note} diff --git a/docs/community/faq.md b/docs/community/faq.md index 59a672d6..d13dff1b 100644 --- a/docs/community/faq.md +++ b/docs/community/faq.md @@ -1,7 +1,7 @@ --- layout: default title: FAQ -parent: community +parent: Community nav_order: 1 description: overview of the major modules and classes of LLMWare permalink: /community/faq diff --git a/docs/community/join_our_community.md b/docs/community/join_our_community.md index 5d26c847..aea779a8 100644 --- a/docs/community/join_our_community.md +++ b/docs/community/join_our_community.md @@ -1,7 +1,7 @@ --- layout: default title: Join Our Community -parent: community +parent: Community nav_order: 4 description: overview of the major modules and classes of LLMWare permalink: /community/join_our_community diff --git a/docs/community/need_help.md b/docs/community/need_help.md index afc99187..7ca6c6f0 100644 --- a/docs/community/need_help.md +++ b/docs/community/need_help.md @@ -1,7 +1,7 @@ --- layout: default title: Need Hep -parent: community +parent: Community nav_order: 3 description: overview of the major modules and classes of LLMWare permalink: /community/need_help diff --git a/docs/community/troubleshooting.md b/docs/community/troubleshooting.md index 6812f9dd..57586090 100644 --- a/docs/community/troubleshooting.md +++ b/docs/community/troubleshooting.md @@ -1,7 +1,7 @@ --- layout: default title: Troubleshooting -parent: community +parent: Community nav_order: 2 description: overview of the major modules and classes of LLMWare permalink: /community/troubleshooting diff --git a/docs/components/components.md b/docs/components/components.md index 23cb5293..a9fd0ffd 100644 --- a/docs/components/components.md +++ b/docs/components/components.md @@ -1,7 +1,7 @@ --- layout: default title: Components -nav_order: 2 +nav_order: 3 has_children: true description: llmware key architectural components, modules and classes permalink: /components diff --git a/docs/components/library.md b/docs/components/library.md index e6dcc25a..210ed7d9 100644 --- a/docs/components/library.md +++ b/docs/components/library.md @@ -6,7 +6,7 @@ nav_order: 7 description: overview of the major modules and classes of LLMWare permalink: /components/library --- -# Library: ingest, organize and index a collection of knowledge at scale - Parse, Text Chunk and Embed. +# Library: ingest, organize and index a collection of knowledge at scale - Parse, Text Chunk and Embed. --- Library is the main organizing construct for unstructured information in LLMWare. Users can create one large library with all types of different content, or diff --git a/docs/components/model_catalog.md b/docs/components/model_catalog.md index a6263c1f..8bd4adee 100644 --- a/docs/components/model_catalog.md +++ b/docs/components/model_catalog.md @@ -9,10 +9,10 @@ permalink: /components/model_catalog # Model Catalog: Access all models the same way with easy lookup, regardless of underlying implementation. -# 150+ Models in Catalog with 50+ RAG-optimized BLING, DRAGON and Industry BERT models -# 18 SLIM function-calling small language models for Agent use cases -# Full support for GGUF, HuggingFace, Sentence Transformers and major API-based models -# Easy to extend to add custom models - see examples +- 150+ Models in Catalog with 50+ RAG-optimized BLING, DRAGON and Industry BERT models +- 18 SLIM function-calling small language models for Agent use cases +- Full support for GGUF, HuggingFace, Sentence Transformers and major API-based models +- Easy to extend to add custom models - see examples Generally, all models can be identified using either the `model_name` or `display_name`, which provides some flexibility to expose a more "UI friendly" name or an informal short-name for a commonly-used model. diff --git a/docs/contributing/contributing.md b/docs/contributing/contributing.md index 394fae54..feec1fdc 100644 --- a/docs/contributing/contributing.md +++ b/docs/contributing/contributing.md @@ -1,7 +1,7 @@ --- layout: default title: Contributing -nav_order: 6 +nav_order: 7 has_children: true description: llmware contributions. permalink: /contributing diff --git a/docs/examples/agents.md b/docs/examples/agents.md index ef39e737..cd649a48 100644 --- a/docs/examples/agents.md +++ b/docs/examples/agents.md @@ -1,7 +1,7 @@ --- layout: default title: Agents -parent: examples +parent: Examples nav_order: 2 description: overview of the major modules and classes of LLMWare permalink: /examples/agents diff --git a/docs/examples/datasets.md b/docs/examples/datasets.md index 59c883fe..ca0e15d2 100644 --- a/docs/examples/datasets.md +++ b/docs/examples/datasets.md @@ -1,7 +1,7 @@ --- layout: default title: Datasets -parent: examples +parent: Examples nav_order: 10 description: overview of the major modules and classes of LLMWare permalink: /examples/datasets diff --git a/docs/examples/embedding.md b/docs/examples/embedding.md index dab2cc34..6ca6267a 100644 --- a/docs/examples/embedding.md +++ b/docs/examples/embedding.md @@ -1,7 +1,7 @@ --- layout: default title: Embedding -parent: examples +parent: Examples nav_order: 5 description: overview of the major modules and classes of LLMWare permalink: /examples/embedding diff --git a/docs/examples/examples.md b/docs/examples/examples.md index eb0f6aaf..89f6a924 100644 --- a/docs/examples/examples.md +++ b/docs/examples/examples.md @@ -1,7 +1,7 @@ --- layout: default title: Examples -nav_order: 4 +nav_order: 5 has_children: true description: examples, recipes and use cases permalink: /examples diff --git a/docs/examples/getting_started.md b/docs/examples/getting_started.md index b444b39c..af8dbfb5 100644 --- a/docs/examples/getting_started.md +++ b/docs/examples/getting_started.md @@ -1,8 +1,9 @@ --- layout: default title: Introduction by Examples +parent: Examples nav_order: 9 -permalink: /examples +permalink: /examples/getting_started --- # Introduction by Examples We introduce ``llmware`` through self-contained examples. diff --git a/docs/examples/models.md b/docs/examples/models.md index ba6aab50..d009991f 100644 --- a/docs/examples/models.md +++ b/docs/examples/models.md @@ -1,7 +1,7 @@ --- layout: default title: Models -parent: Learn +parent: Examples nav_order: 3 description: overview of the major modules and classes of LLMWare permalink: /examples/models diff --git a/docs/examples/notebooks.md b/docs/examples/notebooks.md index d534ee00..f9a6ac47 100644 --- a/docs/examples/notebooks.md +++ b/docs/examples/notebooks.md @@ -1,7 +1,7 @@ --- layout: default title: Notebooks -parent: examples +parent: Examples nav_order: 11 description: overview of the major modules and classes of LLMWare permalink: /examples/notebooks diff --git a/docs/examples/parsing.md b/docs/examples/parsing.md index 4cca6b65..f4ae655b 100644 --- a/docs/examples/parsing.md +++ b/docs/examples/parsing.md @@ -1,7 +1,7 @@ --- layout: default title: Parsing -parent: examples +parent: Examples nav_order: 4 description: overview of the major modules and classes of LLMWare permalink: /examples/parsing diff --git a/docs/examples/prompts.md b/docs/examples/prompts.md index 7d7b0f5c..8a2a206b 100644 --- a/docs/examples/prompts.md +++ b/docs/examples/prompts.md @@ -1,7 +1,7 @@ --- layout: default title: Prompts -parent: examples +parent: Examples nav_order: 6 description: overview of the major modules and classes of LLMWare permalink: /examples/prompts diff --git a/docs/examples/retrieval.md b/docs/examples/retrieval.md index 45fbfba7..acf9158e 100644 --- a/docs/examples/retrieval.md +++ b/docs/examples/retrieval.md @@ -1,7 +1,7 @@ --- layout: default title: Retrieval -parent: examples +parent: Examples nav_order: 7 description: overview of the major modules and classes of LLMWare permalink: /examples/retrieval diff --git a/docs/examples/structured_tables.md b/docs/examples/structured_tables.md index ec2d2a92..ce224f23 100644 --- a/docs/examples/structured_tables.md +++ b/docs/examples/structured_tables.md @@ -1,7 +1,7 @@ --- layout: default title: Structured Tables -parent: examples +parent: Examples nav_order: 9 description: overview of the major modules and classes of LLMWare permalink: /examples/structured_tables diff --git a/docs/examples/ui.md b/docs/examples/ui.md index 587a6fbd..5e67940c 100644 --- a/docs/examples/ui.md +++ b/docs/examples/ui.md @@ -1,7 +1,7 @@ --- layout: default title: UI -parent: examples +parent: Examples nav_order: 8 description: overview of the major modules and classes of LLMWare permalink: /examples/ui diff --git a/docs/examples/use_cases.md b/docs/examples/use_cases.md index 0b4287d1..f94318c0 100644 --- a/docs/examples/use_cases.md +++ b/docs/examples/use_cases.md @@ -1,7 +1,7 @@ --- layout: default title: Use Cases -parent: examples +parent: Examples nav_order: 1 description: overview of the major modules and classes of LLMWare permalink: /examples/use_cases diff --git a/docs/getting_started/getting_started.md b/docs/getting_started/getting_started.md index b22656aa..0c88493e 100644 --- a/docs/getting_started/getting_started.md +++ b/docs/getting_started/getting_started.md @@ -1,7 +1,7 @@ --- layout: default title: Getting Started -nav_order: 1 +nav_order: 2 has_children: true description: getting started with llmware permalink: /getting_started diff --git a/docs/learn/learn.md b/docs/learn/learn.md index 9356e951..22a1c461 100644 --- a/docs/learn/learn.md +++ b/docs/learn/learn.md @@ -1,7 +1,7 @@ --- layout: default title: Learn -nav_order: 3 +nav_order: 4 has_children: true description: key learning resources permalink: /learn