Commit c76918a
committed
docs: quickstart guide with interactive LLM and project structure (#2380)
## Changes Made
### Documentation (docs/getstarted/evals.md):
- Added `quickstart` cmd to follow through guide with an example
project.
- Updated "Custom Evaluation with LLMs" to reference DiscreteMetric from
generated code
- Replaced static examples with modern `llm_factory` API
- Changed "Using Pre-Built Metrics" to AspectCritic with modern
async/await
syntax
- Updated "Evaluating on a Dataset" to use ragas.Dataset API
### Build Configuration (mkdocs.yml):
- Made social plugin conditional: `enabled: !ENV [MKDOCS_CI, true]`
### Makefile:
- Added explicit `MKDOCS_CI=false` to serve-docs target. This avoids
social plugin error in macos if in case `cairosvg` is not found.1 parent 9601bbe commit c76918a
File tree
17 files changed
+555
-215
lines changed- docs
- _static/imgs/results
- getstarted
- howtos
- applications
- integrations
- examples/ragas_examples/rag_eval
- src/ragas
- tests/unit
17 files changed
+555
-215
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
161 | 161 | | |
162 | 162 | | |
163 | 163 | | |
164 | | - | |
| 164 | + | |
165 | 165 | | |
166 | 166 | | |
167 | | - | |
| 167 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
97 | 97 | | |
98 | 98 | | |
99 | 99 | | |
100 | | - | |
| 100 | + | |
101 | 101 | | |
102 | 102 | | |
103 | | - | |
104 | | - | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
105 | 106 | | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
106 | 118 | | |
107 | 119 | | |
108 | 120 | | |
109 | 121 | | |
110 | | - | |
111 | | - | |
112 | | - | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
113 | 129 | | |
114 | 130 | | |
| 131 | + | |
| 132 | + | |
115 | 133 | | |
116 | 134 | | |
117 | 135 | | |
| |||
Loading
0 commit comments