Skip to content

Commit 0195c32

Browse files
authored
Update readme style (#24)
* changes in style to the readme * add line break
1 parent a4cb08c commit 0195c32

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,31 @@
99
</picture>
1010
</p>
1111

12-
# Structured-QA: a Blueprint by Mozilla.ai for answering questions about structured documents.
13-
12+
<div align="center">
1413

15-
[![](https://dcbadge.limes.pink/api/server/YuMNeuKStr?style=flat)](https://discord.gg/YuMNeuKStr)
14+
![Python](https://img.shields.io/badge/Python-3.10%2B-blue)
15+
[![llama.cpp](https://img.shields.io/badge/llama.cpp-E76F00?logo=cplusplus&logoColor=white&labelColor=1E1E1E)](https://github.com/ggml-org/llama.cpp)
16+
[![pymupdf4llm](https://img.shields.io/badge/pymupdf4llm-blue)](https://pymupdf.readthedocs.io/en/latest/pymupdf4llm/index.html)
17+
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
18+
[![](https://dcbadge.limes.pink/api/server/YuMNeuKStr?style=flat)](https://discord.gg/YuMNeuKStr) <br>
1619
[![Docs](https://github.com/mozilla-ai/structured-qa/actions/workflows/docs.yaml/badge.svg)](https://github.com/mozilla-ai/structured-qa/actions/workflows/docs.yaml/)
1720
[![Tests](https://github.com/mozilla-ai/structured-qa/actions/workflows/tests.yaml/badge.svg)](https://github.com/mozilla-ai/structured-qa/actions/workflows/tests.yaml/)
1821
[![Ruff](https://github.com/mozilla-ai/structured-qa/actions/workflows/lint.yaml/badge.svg?label=Ruff)](https://github.com/mozilla-ai/structured-qa/actions/workflows/lint.yaml/)
1922

23+
[Blueprints Hub](https://developer-hub.mozilla.ai/)
24+
| [Documentation](https://mozilla-ai.github.io/structured-qa/)
25+
| [Getting Started](https://mozilla-ai.github.io/structured-qa/getting-started/)
26+
| [Contributing](CONTRIBUTING.md)
2027

21-
This Blueprint demonstrates how to use open-source models and a simple LLM workflow to answer questions based on structured documents.
22-
23-
It is designed to showcase a simpler alternative to more complex and/or resource demanding alternatives, such as RAG systems that rely on vectorDBs and/or long-context models with large token windows.
28+
</div>
2429

25-
<img src="./images/structured-qa-diagram.png" width="1200" alt="structure-qa Diagram" />
30+
# Structured-QA: a Blueprint by Mozilla.ai for answering questions about structured documents.
2631

27-
📘 To explore this project further and discover other Blueprints, visit the [**Blueprints Hub**](https://developer-hub.mozilla.ai/blueprints/query-structured-documents-using-a-lightweight-llm-workflow).
32+
This Blueprint demonstrates how to use open-source models and a simple LLM workflow to answer questions based on structured documents.
2833

34+
It is designed to showcase a simpler alternative to more complex and/or resource-demanding alternatives, such as RAG systems that rely on vector databases and/or long-context models with large token windows.
2935

30-
### 👉 📖 For more detailed guidance on using this project, please visit our [Docs here](https://mozilla-ai.github.io/structured-qa/).
36+
<img src="./images/structured-qa-diagram.png" width="1200" alt="Structured QA Diagram" />
3137

3238

3339
## Quick-start

0 commit comments

Comments
 (0)