mirror of
https://github.com/meta-llama/llama-stack.git
synced 2025-12-03 01:48:05 +00:00
5fe6098350
# What does this PR do? This PR improves type hint cleanup in auto-generated provider documentation by adding regex logic. **Issues Fixed:** - Type hints with missing closing brackets (e.g., `list[str` instead of `list[str]`) - Types showing as `<class 'bool'>`, `<class 'str'>` instead of `bool`, `str` - The multi-line YAML frontmatter in index documentation files wasn't ideal, so we now add the proper `|` character. **Changes:** 1. Replaced string replacement (`.replace`) with regex-based type cleaning to preserve the trailing bracket in case of `list` and `dict`. 2. Adds the `|` character for multi-line YAML descriptions. 3. I have regenerated the docs. However, let me know if that's not needed. ## Test Plan 1. Ran uv run python scripts/provider_codegen.py - successfully regenerated all docs 2. We can see that the updated docs handle correctly type hint cleanup and multi-line yaml descriptions have now the `|` character. ### Note to the reviewer(s) This is my first contribution to your lovely repo! Initially I was going thourgh docs (wanted to use `remote::gemini` as provider) and realized the issue. I've read the [CONTRIBUTING.md](https://github.com/llamastack/llama-stack/blob/main/CONTRIBUTING.md) and decided to open the PR. Let me know if there's anything I did wrong and I'll update my PR! --------- Signed-off-by: thepetk <thepetk@gmail.com> Co-authored-by: Ashwin Bharambe <ashwin.bharambe@gmail.com>
30 lines
597 B
Text
30 lines
597 B
Text
---
|
|
description: "Meta's reference implementation of a vector database."
|
|
sidebar_label: Meta-Reference
|
|
title: inline::meta-reference
|
|
---
|
|
|
|
# inline::meta-reference
|
|
|
|
## Description
|
|
|
|
Meta's reference implementation of a vector database.
|
|
|
|
## Configuration
|
|
|
|
| Field | Type | Required | Default | Description |
|
|
|-------|------|----------|---------|-------------|
|
|
| `persistence` | `KVStoreReference` | No | | |
|
|
|
|
## Sample Configuration
|
|
|
|
```yaml
|
|
persistence:
|
|
namespace: vector_io::faiss
|
|
backend: kv_default
|
|
```
|
|
## Deprecation Notice
|
|
|
|
:::warning
|
|
Please use the `inline::faiss` provider instead.
|
|
:::
|