Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

updating docs #866

Merged
merged 1 commit into from
Jun 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/community/community.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
---
layout: default
title: Community
nav_order: 5
nav_order: 6
has_children: true
description: community resources, getting help and sharing ideas
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}
Expand Down
2 changes: 1 addition & 1 deletion docs/community/faq.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/community/join_our_community.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/community/need_help.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/community/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/components/components.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/components/library.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. </summary>
# 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
Expand Down
8 changes: 4 additions & 4 deletions docs/components/model_catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/contributing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Contributing
nav_order: 6
nav_order: 7
has_children: true
description: llmware contributions.
permalink: /contributing
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/agents.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/datasets.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/embedding.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/examples.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/examples/getting_started.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/models.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/notebooks.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/parsing.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/prompts.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/retrieval.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/structured_tables.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/ui.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/use_cases.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started/getting_started.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/learn.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: default
title: Learn
nav_order: 3
nav_order: 4
has_children: true
description: key learning resources
permalink: /learn
Expand Down