Skip to content

Commit 6e3ace7

Browse files
committed
docs: replace em-dashes and double-dashes with colons and plain text
1 parent d4e1774 commit 6e3ace7

2 files changed

Lines changed: 21 additions & 21 deletions

File tree

docs/user_guide/how_to_guides/index.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,41 @@ How-to guides are **task-oriented** recipes that help you accomplish specific go
77

88
:::{grid-item-card} 🤖 LLM Extensions
99

10-
- [Cache LLM Responses](../03_llmcache.ipynb) -- semantic caching to reduce costs and latency
11-
- [Use LangCache as the LLM cache](../13_langcache_semantic_cache.ipynb) -- managed cache service with LangCache
12-
- [Manage LLM Message History](../07_message_history.ipynb) -- persistent chat history with relevancy retrieval
13-
- [Route Queries with SemanticRouter](../08_semantic_router.ipynb) -- classify intents and route queries
10+
- [Cache LLM Responses](../03_llmcache.ipynb): semantic caching to reduce costs and latency
11+
- [Use LangCache as the LLM cache](../13_langcache_semantic_cache.ipynb): managed cache service with LangCache
12+
- [Manage LLM Message History](../07_message_history.ipynb): persistent chat history with relevancy retrieval
13+
- [Route Queries with SemanticRouter](../08_semantic_router.ipynb): classify intents and route queries
1414
:::
1515

1616
:::{grid-item-card} 🔍 Querying
1717

18-
- [Query and Filter Data](../02_complex_filtering.ipynb) -- combine tag, numeric, geo, and text filters
19-
- [Use Advanced Query Types](../11_advanced_queries.ipynb) -- hybrid, multi-vector, range, and text queries
20-
- [Write SQL Queries for Redis](../12_sql_to_redis_queries.ipynb) -- translate SQL to Redis query syntax
18+
- [Query and Filter Data](../02_complex_filtering.ipynb): combine tag, numeric, geo, and text filters
19+
- [Use Advanced Query Types](../11_advanced_queries.ipynb): hybrid, multi-vector, range, and text queries
20+
- [Write SQL Queries for Redis](../12_sql_to_redis_queries.ipynb): translate SQL to Redis query syntax
2121
:::
2222

2323
:::{grid-item-card} 🧮 Embeddings
2424

25-
- [Create Embeddings with Vectorizers](../04_vectorizers.ipynb) -- OpenAI, Cohere, HuggingFace, and more
26-
- [Cache Embeddings](../10_embeddings_cache.ipynb) -- reduce costs by caching embedding vectors
25+
- [Create Embeddings with Vectorizers](../04_vectorizers.ipynb): OpenAI, Cohere, HuggingFace, and more
26+
- [Cache Embeddings](../10_embeddings_cache.ipynb): reduce costs by caching embedding vectors
2727
:::
2828

2929
:::{grid-item-card} ⚡ Optimization
3030

31-
- [Rerank Search Results](../06_rerankers.ipynb) -- improve relevance with cross-encoders and rerankers
32-
- [Optimize Indexes with SVS-VAMANA](../09_svs_vamana.ipynb) -- graph-based vector search with compression
31+
- [Rerank Search Results](../06_rerankers.ipynb): improve relevance with cross-encoders and rerankers
32+
- [Optimize Indexes with SVS-VAMANA](../09_svs_vamana.ipynb): graph-based vector search with compression
3333
:::
3434

3535
:::{grid-item-card} 💾 Storage
3636

37-
- [Choose a Storage Type](../05_hash_vs_json.ipynb) -- Hash vs JSON formats and nested data
38-
- [Migrate an Index](migrate-indexes.md) -- use the migrator helper, wizard, plan, apply, and validate workflow
37+
- [Choose a Storage Type](../05_hash_vs_json.ipynb): Hash vs JSON formats and nested data
38+
- [Migrate an Index](migrate-indexes.md): use the migrator helper, wizard, plan, apply, and validate workflow
3939
:::
4040

4141
:::{grid-item-card} 💻 CLI Operations
4242

43-
- [Manage Indices with the CLI](../cli.ipynb) -- create, inspect, and delete indices from your terminal
44-
- [Run RedisVL MCP](mcp.md) -- expose an existing Redis index to MCP clients
43+
- [Manage Indices with the CLI](../cli.ipynb): create, inspect, and delete indices from your terminal
44+
- [Run RedisVL MCP](mcp.md): expose an existing Redis index to MCP clients
4545
:::
4646

4747
::::

docs/user_guide/how_to_guides/migrate-indexes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -686,7 +686,7 @@ rvl migrate validate \
686686

687687
**Apply flags (quantization & reliability):**
688688
- `--backup-dir <dir>` : Directory for vector backup files. Enables crash-safe resume and manual rollback. Required when using `--workers` > 1.
689-
- `--batch-size <N>` : Keys per pipeline batch (default 500). Values 2001000 are typical.
689+
- `--batch-size <N>` : Keys per pipeline batch (default 500). Values 200 to 1000 are typical.
690690
- `--workers <N>` : Parallel quantization workers (default 1). Each worker opens its own Redis connection. See [Performance](#performance-tuning) for guidance.
691691
- `--keep-backup` : Retain backup files after a successful migration (default: auto-cleanup).
692692

@@ -736,10 +736,10 @@ When you pass `--backup-dir` (or `backup_dir` in the Python API), the
736736
migration executor saves **original vector bytes** to disk before mutating
737737
them. This enables two key capabilities:
738738

739-
1. **Crash-safe resume** if the process dies mid-migration, re-running the
739+
1. **Crash-safe resume**: if the process dies mid-migration, re-running the
740740
same command with the same `--backup-dir` automatically detects partial
741741
progress and resumes from the last completed batch.
742-
2. **Manual rollback** the backup files contain the original (pre-quantization)
742+
2. **Manual rollback**: the backup files contain the original (pre-quantization)
743743
vector values, which can be restored to undo a migration.
744744

745745
Backup files are written to the specified directory with this layout:
@@ -767,7 +767,7 @@ the exact same command:
767767
rvl migrate apply --plan plan.yaml --url redis://localhost:6379 \
768768
--backup-dir /tmp/backups --workers 4
769769
770-
# Just re-run it — progress is resumed automatically
770+
# Just re-run it. Progress is resumed automatically
771771
rvl migrate apply --plan plan.yaml --url redis://localhost:6379 \
772772
--backup-dir /tmp/backups --workers 4
773773
```
@@ -1164,7 +1164,7 @@ phase of a datatype migration. Observed throughput on a local Redis instance:
11641164

11651165
**Guidance:**
11661166
- For **low-dimensional vectors** (≤ 256 dims), use `--workers 1` (the default). Per-vector conversion is so cheap that process-spawning and extra-connection overhead outweigh the parallelism benefit.
1167-
- For **high-dimensional vectors** (≥ 768 dims), `--workers 2-4` may help if the Redis server has available CPU headroom. Diminishing returns above 48 workers on a single Redis instance because Redis command processing is single-threaded.
1167+
- For **high-dimensional vectors** (≥ 768 dims), `--workers 2-4` may help if the Redis server has available CPU headroom. Diminishing returns above 4 to 8 workers on a single Redis instance because Redis command processing is single-threaded.
11681168
- The main bottleneck for large migrations is typically **index rebuild time** (the `FT.CREATE` background indexing after vectors are written), not quantization itself.
11691169

11701170
### Batch Size
@@ -1188,7 +1188,7 @@ mutation. Approximate size: `num_docs × dims × bytes_per_element`.
11881188

11891189
```{note}
11901190
When migrating from **HNSW** to **FLAT**, the target index may report a
1191-
*higher* document count than the source. This is not a bug it reflects
1191+
*higher* document count than the source. This is not a bug; it reflects
11921192
a fundamental difference in how the two algorithms store vectors.
11931193
11941194
HNSW maintains a navigable small-world graph with per-node neighbor lists.

0 commit comments

Comments
 (0)