Skip to content

Commit

Permalink
chore(docs): more mkdocs links fixes (#80)
Browse files Browse the repository at this point in the history
- clean up build docs build warnings
- fix up a couple broken readme paths
  • Loading branch information
martenpayne committed Nov 3, 2023
1 parent 175159c commit 74b1145
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ For full documentation, see <https://aws-samples.github.io/aws-genai-conversatio

## Key Documentation Links

- **[Overview](https://aws-samples.github.io/aws-genai-conversational-rag-reference)**
- **[Mental Model](https://aws-samples.github.io/aws-genai-conversational-rag-reference/model)**
- **[How it Works](https://aws-samples.github.io/aws-genai-conversational-rag-reference/overview)**
- **[Getting Started](https://aws-samples.github.io/aws-genai-conversational-rag-reference/quick-start)**
- **[Security Considerations](https://aws-samples.github.io/aws-genai-conversational-rag-reference/security)**
- **[Contributing](https://aws-samples.github.io/aws-genai-conversational-rag-reference/contributing)**
- **[Developer Guide](https://aws-samples.github.io/aws-genai-conversational-rag-reference/developing)**
- **[Overview](https://aws-samples.github.io/aws-genai-conversational-rag-reference/overview/)**
- **[Mental Model](https://aws-samples.github.io/aws-genai-conversational-rag-reference/model/)**
- **[How it Works](https://aws-samples.github.io/aws-genai-conversational-rag-reference/overview/how/)**
- **[Getting Started](https://aws-samples.github.io/aws-genai-conversational-rag-reference/quick-start/)**
- **[Security Considerations](https://aws-samples.github.io/aws-genai-conversational-rag-reference/security/)**
- **[Contributing](https://aws-samples.github.io/aws-genai-conversational-rag-reference/contributing/)**
- **[Developer Guide](https://aws-samples.github.io/aws-genai-conversational-rag-reference/development/)**

---

Expand Down
2 changes: 1 addition & 1 deletion docs/content/development/models/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Predefined Models

Galileo supports a number of predefined large language models (LLMs), including all available non-embeddings text-to-text models provided by Bedrock, and a number of SageMaker JumpStart models (Falcon40b, Falcon7b, Falcon Lite, Jurassic Ultra, and Meta LLama2). If you use the "galileo-cli" convenience deployment task, you can select a range of these predefined models (including which to use by default) to be included in a Galileo deployment. Once deployed, you can use the [prompt development settings UI](../dev-settings) to change which predefined model is active for a chat session.
Galileo supports a number of predefined large language models (LLMs), including all available non-embeddings text-to-text models provided by Bedrock, and a number of SageMaker JumpStart models (Falcon40b, Falcon7b, Falcon Lite, Jurassic Ultra, and Meta LLama2). If you use the "galileo-cli" convenience deployment task, you can select a range of these predefined models (including which to use by default) to be included in a Galileo deployment. Once deployed, you can use the [prompt development settings UI](../dev-settings/index.md) to change which predefined model is active for a chat session.

??? abstract "Current list of predefined models"
--8<-- "development/models/predefined-models.md"
Expand Down
2 changes: 1 addition & 1 deletion docs/content/development/vstore/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The "processed bucket" is the destination for objects that have already been pro
This is very much an example architecture for data ingestion at scale, and is expected to be replaced or modified to support your specific use case. Rather than attempting to force your implementation into the current process, it is recommended to replace this based on your needs. As we learn more about the patterns customers are using, we will work on extending this to support more real world use cases.

!!! warning "Manual Process"
Currently the state machine must be manually triggered. It also supports scheduling which is disabled by default, which can be configured in the [../../../../demo/infra/src/application/corpus/index.ts](corpus stack) properties.
Currently the state machine must be manually triggered. It also supports scheduling which is disabled by default, which can be configured in the corpus stack ('demo/infra/src/application/corpus/index.ts') properties.

## Sample Dataset

Expand Down
2 changes: 1 addition & 1 deletion docs/content/overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The screenshot below shows the default web interface, showing an active chat ses

## Architecture

This simplified architecture diagram shows the key service components utilised to implemented each of the three tiers described described in the [mental model](./model).
This simplified architecture diagram shows the key service components utilised to implemented each of the three tiers described described in the [mental model](./model/index.md).

![Architecture](../assets/images/galileo-arch.png)

Expand Down

0 comments on commit 74b1145

Please sign in to comment.