Stefano Fiorucci commited on
Commit
0ef7038
β€’
1 Parent(s): f791cdb

first draft for readme

Browse files
README.md CHANGED
@@ -10,4 +10,22 @@ pinned: false
10
  license: mit
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces#reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
10
  license: mit
11
  ---
12
 
13
+ # Who killed Laura Palmer?   [![Generic badge](https://img.shields.io/badge/πŸ€—-Open%20in%20Spaces-blue.svg)](https://huggingface.co/spaces/anakin87/who-killed-laura-palmer) [![Generic badge](https://img.shields.io/github/stars/anakin87/who-killed-laura-palmer?label=Github&style=social)](https://github.com/anakin87/who-killed-laura-palmer)
14
+ ## πŸ—»πŸ—» Twin Peaks Question Answering system
15
+
16
+ WKLP is a simple Question Answering system, based on data crawled from [Twin Peaks Wiki](https://twinpeaks.fandom.com/wiki/Twin_Peaks_Wiki). It is built using [πŸ” Haystack](https://github.com/deepset-ai/haystack), an awesome open-source framework for building search systems that work intelligently over large document collections.
17
+
18
+ ---
19
+
20
+ ## Project architecture 🧱
21
+
22
+ ![Project architecture](./data/readme_images/project_architecture.png)
23
+
24
+ * Crawler: implemented using [Scrapy](https://github.com/scrapy/scrapy) and [fandom-py](https://github.com/NikolajDanger/fandom-py)
25
+ * Question Answering pipelines: created with [Haystack](https://github.com/deepset-ai/haystack)
26
+ * Web app: developed with [Streamlit](https://github.com/streamlit/streamlit)
27
+ * Free hosting: [Hugging Face Spaces](https://huggingface.co/spaces)
28
+
29
+ ---
30
+
31
+ ## What can I learn from this project? πŸ“š
data/readme_images/project_architecture.png ADDED