Skip to content

Commit 17053f3

Browse files
SergiiShcherbakSergiiShcherbak
committed
Docs and README
1 parent fe7c262 commit 17053f3

File tree

2 files changed

+58
-58
lines changed

2 files changed

+58
-58
lines changed

‎README.md‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
4040
<td>⭐</td>
4141
<td>
4242
<strong>Automated dynamic prompts</strong><br>
43-
<sub>
43+
<i>
4444
Automatically generates comprehensive prompts for your specific extraction needs.
45-
</sub>
45+
</i>
4646
</td>
4747
<td>✅</td>
4848
<td>❌</td>
@@ -51,9 +51,9 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
5151
<td>⭐</td>
5252
<td>
5353
<strong>Automated data modelling and validators</strong><br>
54-
<sub>
54+
<i>
5555
Automatically creates data models and validation logic.
56-
</sub>
56+
</i>
5757
</td>
5858
<td>✅</td>
5959
<td>❌</td>
@@ -62,9 +62,9 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
6262
<td>⭐</td>
6363
<td>
6464
<strong>Single, unified extraction pipeline (declarative, reusable, fully serializable)</strong><br>
65-
<sub>
65+
<i>
6666
Allows to define a complete extraction workflow in a single, unified, reusable pipeline.
67-
</sub>
67+
</i>
6868
</td>
6969
<td>✅</td>
7070
<td>❌</td>
@@ -73,10 +73,10 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
7373
<td>⭐</td>
7474
<td>
7575
<strong>Precise granular reference mapping (paragraphs & sentences)</strong><br>
76-
<sub>
76+
<i>
7777
Automatically maps extracted data to the relevant parts of the document, which will always match
7878
in the source document, with customizable granularity.
79-
</sub>
79+
</i>
8080
</td>
8181
<td>✅</td>
8282
<td>❌</td>
@@ -85,10 +85,10 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
8585
<td>⭐</td>
8686
<td>
8787
<strong>Justifications (reasoning backing the extraction)</strong><br>
88-
<sub>
88+
<i>
8989
Automatically provides justifications for each extraction, with
9090
customizable granularity.
91-
</sub>
91+
</i>
9292
</td>
9393
<td>✅</td>
9494
<td>❌</td>
@@ -97,10 +97,10 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
9797
<td>⭐</td>
9898
<td>
9999
<strong>Neural segmentation (SaT)</strong><br>
100-
<sub>
100+
<i>
101101
Automatically segments the document into paragraphs and sentences using state-of-the-art SaT
102102
models, compatible with many languages.
103-
</sub>
103+
</i>
104104
</td>
105105
<td>✅</td>
106106
<td>❌</td>
@@ -109,9 +109,9 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
109109
<td>⭐</td>
110110
<td>
111111
<strong>Multilingual support (I/O without prompting)</strong><br>
112-
<sub>
112+
<i>
113113
Supports multiple languages in input and output without additional prompting.
114-
</sub>
114+
</i>
115115
</td>
116116
<td>✅</td>
117117
<td>❌</td>
@@ -120,10 +120,10 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
120120
<td>⭐</td>
121121
<td>
122122
<strong>Grouped LLMs with role-specific tasks</strong><br>
123-
<sub>
123+
<i>
124124
Allows to easily group LLMs with different roles to process role-specific
125125
tasks in the pipeline.
126-
</sub>
126+
</i>
127127
</td>
128128
<td>✅</td>
129129
<td>❌</td>
@@ -132,10 +132,10 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
132132
<td>⭐</td>
133133
<td>
134134
<strong>Nested context extraction</strong><br>
135-
<sub>
135+
<i>
136136
Automatically manages nested context based on the pipeline definition (e.g.
137137
document > aspects > sub-aspects > concepts).
138-
</sub>
138+
</i>
139139
</td>
140140
<td>✅</td>
141141
<td>⚠️</td>
@@ -144,10 +144,10 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
144144
<td>⭐</td>
145145
<td>
146146
<strong>Built-in concurrent I/O processing</strong><br>
147-
<sub>
147+
<i>
148148
Automatically manages concurrent I/O processing to speed up complex
149149
extraction workflows, with a simple switch (<code>use_concurrency=True</code>).
150-
</sub>
150+
</i>
151151
</td>
152152
<td>✅</td>
153153
<td>⚠️</td>
@@ -156,9 +156,9 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
156156
<td>⭐</td>
157157
<td>
158158
<strong>Fallback and retry logic</strong><br>
159-
<sub>
159+
<i>
160160
Built-in retry logic and easily attachable fallback LLMs.
161-
</sub>
161+
</i>
162162
</td>
163163
<td>✅</td>
164164
<td>✅</td>
@@ -167,9 +167,9 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
167167
<td>⭐</td>
168168
<td>
169169
<strong>Multiple LLM providers</strong><br>
170-
<sub>
170+
<i>
171171
Compatible with a wide range of commercial and locally hosted LLMs.
172-
</sub>
172+
</i>
173173
</td>
174174
<td>✅</td>
175175
<td>✅</td>
@@ -178,19 +178,19 @@ Read more on the project [motivation](https://contextgem.dev/motivation.html) in
178178
<td>⭐</td>
179179
<td>
180180
<strong>Usage & costs tracking</strong><br>
181-
<sub>
181+
<i>
182182
Automatically tracks usage (calls, tokens, costs) of all LLM calls.
183-
</sub>
183+
</i>
184184
</td>
185185
<td>✅</td>
186186
<td>✅</td>
187187
</tr>
188188
</tbody>
189189
</table>
190190

191-
✅ - <sub>fully supported - no additional setup required</sub><br>
192-
⚠️ - <sub>partially supported - requires additional setup</sub><br>
193-
❌ - <sub>not supported - requires custom logic</sub>
191+
✅ - fully supported - no additional setup required<br>
192+
⚠️ - partially supported - requires additional setup<br>
193+
❌ - not supported - requires custom logic
194194

195195
\* See [comparison](https://contextgem.dev/vs_other_frameworks.html) of specific implementation examples using ContextGem and other popular open-source LLM frameworks.
196196

‎dev/content_snippets/feature_table.html‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
<td>⭐</td>
1313
<td>
1414
<strong>Automated dynamic prompts</strong><br>
15-
<sub>
15+
<i>
1616
Automatically generates comprehensive prompts for your specific extraction needs.
17-
</sub>
17+
</i>
1818
</td>
1919
<td>✅</td>
2020
<td>❌</td>
@@ -23,9 +23,9 @@
2323
<td>⭐</td>
2424
<td>
2525
<strong>Automated data modelling and validators</strong><br>
26-
<sub>
26+
<i>
2727
Automatically creates data models and validation logic.
28-
</sub>
28+
</i>
2929
</td>
3030
<td>✅</td>
3131
<td>❌</td>
@@ -34,9 +34,9 @@
3434
<td>⭐</td>
3535
<td>
3636
<strong>Single, unified extraction pipeline (declarative, reusable, fully serializable)</strong><br>
37-
<sub>
37+
<i>
3838
Allows to define a complete extraction workflow in a single, unified, reusable pipeline.
39-
</sub>
39+
</i>
4040
</td>
4141
<td>✅</td>
4242
<td>❌</td>
@@ -45,10 +45,10 @@
4545
<td>⭐</td>
4646
<td>
4747
<strong>Precise granular reference mapping (paragraphs & sentences)</strong><br>
48-
<sub>
48+
<i>
4949
Automatically maps extracted data to the relevant parts of the document, which will always match
5050
in the source document, with customizable granularity.
51-
</sub>
51+
</i>
5252
</td>
5353
<td>✅</td>
5454
<td>❌</td>
@@ -57,10 +57,10 @@
5757
<td>⭐</td>
5858
<td>
5959
<strong>Justifications (reasoning backing the extraction)</strong><br>
60-
<sub>
60+
<i>
6161
Automatically provides justifications for each extraction, with
6262
customizable granularity.
63-
</sub>
63+
</i>
6464
</td>
6565
<td>✅</td>
6666
<td>❌</td>
@@ -69,10 +69,10 @@
6969
<td>⭐</td>
7070
<td>
7171
<strong>Neural segmentation (SaT)</strong><br>
72-
<sub>
72+
<i>
7373
Automatically segments the document into paragraphs and sentences using state-of-the-art SaT
7474
models, compatible with many languages.
75-
</sub>
75+
</i>
7676
</td>
7777
<td>✅</td>
7878
<td>❌</td>
@@ -81,9 +81,9 @@
8181
<td>⭐</td>
8282
<td>
8383
<strong>Multilingual support (I/O without prompting)</strong><br>
84-
<sub>
84+
<i>
8585
Supports multiple languages in input and output without additional prompting.
86-
</sub>
86+
</i>
8787
</td>
8888
<td>✅</td>
8989
<td>❌</td>
@@ -92,10 +92,10 @@
9292
<td>⭐</td>
9393
<td>
9494
<strong>Grouped LLMs with role-specific tasks</strong><br>
95-
<sub>
95+
<i>
9696
Allows to easily group LLMs with different roles to process role-specific
9797
tasks in the pipeline.
98-
</sub>
98+
</i>
9999
</td>
100100
<td>✅</td>
101101
<td>❌</td>
@@ -104,10 +104,10 @@
104104
<td>⭐</td>
105105
<td>
106106
<strong>Nested context extraction</strong><br>
107-
<sub>
107+
<i>
108108
Automatically manages nested context based on the pipeline definition (e.g.
109109
document > aspects > sub-aspects > concepts).
110-
</sub>
110+
</i>
111111
</td>
112112
<td>✅</td>
113113
<td>⚠️</td>
@@ -116,10 +116,10 @@
116116
<td>⭐</td>
117117
<td>
118118
<strong>Built-in concurrent I/O processing</strong><br>
119-
<sub>
119+
<i>
120120
Automatically manages concurrent I/O processing to speed up complex
121121
extraction workflows, with a simple switch (<code>use_concurrency=True</code>).
122-
</sub>
122+
</i>
123123
</td>
124124
<td>✅</td>
125125
<td>⚠️</td>
@@ -128,9 +128,9 @@
128128
<td>⭐</td>
129129
<td>
130130
<strong>Fallback and retry logic</strong><br>
131-
<sub>
131+
<i>
132132
Built-in retry logic and easily attachable fallback LLMs.
133-
</sub>
133+
</i>
134134
</td>
135135
<td>✅</td>
136136
<td>✅</td>
@@ -139,9 +139,9 @@
139139
<td>⭐</td>
140140
<td>
141141
<strong>Multiple LLM providers</strong><br>
142-
<sub>
142+
<i>
143143
Compatible with a wide range of commercial and locally hosted LLMs.
144-
</sub>
144+
</i>
145145
</td>
146146
<td>✅</td>
147147
<td>✅</td>
@@ -150,16 +150,16 @@
150150
<td>⭐</td>
151151
<td>
152152
<strong>Usage & costs tracking</strong><br>
153-
<sub>
153+
<i>
154154
Automatically tracks usage (calls, tokens, costs) of all LLM calls.
155-
</sub>
155+
</i>
156156
</td>
157157
<td>✅</td>
158158
<td>✅</td>
159159
</tr>
160160
</tbody>
161161
</table>
162162

163-
✅ - <sub>fully supported - no additional setup required</sub><br>
164-
⚠️ - <sub>partially supported - requires additional setup</sub><br>
165-
❌ - <sub>not supported - requires custom logic</sub>
163+
✅ - fully supported - no additional setup required<br>
164+
⚠️ - partially supported - requires additional setup<br>
165+
❌ - not supported - requires custom logic

0 commit comments

Comments
 (0)