@@ -11,52 +11,70 @@ NeMo Safe Synthesizer is a comprehensive package for generating safe synthetic d
1111
1212---
1313
14+ ## Key Features
15+
16+ - ** Privacy-first synthetic data** -- PII detection and replacement, optional differential privacy via Opacus
17+ - ** LLM fine-tuning** -- LoRA fine-tuning with HuggingFace or Unsloth backends, quantization support
18+ - ** Fast inference** -- VLLM-powered generation with structured output enforcement
19+ - ** Comprehensive evaluation** -- Privacy metrics, quality scores, distribution analysis, and HTML reports
20+ - ** Flexible interfaces** -- CLI for scripting, Python SDK for programmatic workflows, YAML configuration
21+
22+ ---
23+
1424<div class =" grid cards " markdown >
1525
26+ - ** Product Overview**
27+
28+ ---
29+
30+ Pipeline, data synthesis, PII replacement, and evaluation.
31+
32+ [ :octicons-arrow-right-24: Product Overview] ( product-overview/pipeline.md )
33+
1634- ** Getting Started**
1735
1836 ---
1937
2038 Install the package, set up your environment, and run your first synthetic data pipeline in minutes.
2139
22- [ :octicons-arrow-right-24: Installation] ( getting-started/installation.md )
40+ [ :octicons-arrow-right-24: Getting Started] ( getting-started/installation.md )
41+
42+ - ** Tutorials**
43+
44+ ---
45+
46+ Step-by-step tutorials to get you up and running.
47+
48+ [ :octicons-arrow-right-24: Tutorials] ( tutorials/index.md )
2349
2450- ** User Guide**
2551
2652 ---
2753
28- Learn how to use the CLI, configure pipelines , and work with the Python SDK .
54+ Python SDK, CLI reference, parameters , and troubleshooting .
2955
30- [ :octicons-arrow-right-24: User Guide] ( user-guide/pipeline .md )
56+ [ :octicons-arrow-right-24: User Guide] ( user-guide/sdk .md )
3157
32- - ** Architecture **
58+ - ** Developer Guide **
3359
3460 ---
3561
36- Understand the pipeline design, component architecture, and key design patterns .
62+ Architecture documentation and auto-generated API reference .
3763
38- [ :octicons-arrow-right-24: Architecture ] ( architecture/design .md)
64+ [ :octicons-arrow-right-24: Developer Guide ] ( developer-guide/architecture .md)
3965
40- - ** API Reference **
66+ - ** Developer Notes **
4167
4268 ---
4369
44- Auto-generated reference documentation from source code docstrings .
70+ Blog posts and release notes .
4571
46- [ :octicons-arrow-right-24: API Reference ] ( reference/nemo_safe_synthesizer/sdk/library_builder .md)
72+ [ :octicons-arrow-right-24: Developer Notes ] ( blog/index .md)
4773
4874</div >
4975
5076---
5177
52- ## Key Features
53-
54- - ** Privacy-first synthetic data** -- PII detection and replacement, optional differential privacy via Opacus
55- - ** LLM fine-tuning** -- LoRA fine-tuning with HuggingFace or Unsloth backends, quantization support
56- - ** Fast inference** -- VLLM-powered generation with structured output enforcement
57- - ** Comprehensive evaluation** -- Privacy metrics, quality scores, distribution analysis, and HTML reports
58- - ** Flexible interfaces** -- CLI for scripting, Python SDK for programmatic workflows, YAML configuration
59-
6078## Quick Example
6179
6280``` bash
0 commit comments