GGroenendaal
commited on
Commit
•
6e5b7a2
1
Parent(s):
30fcc69
bump python version
Browse files- README.md +20 -8
- pyproject.toml +1 -1
README.md
CHANGED
@@ -5,6 +5,7 @@ colorFrom: yellow
|
|
5 |
colorTo: blue
|
6 |
sdk: gradio
|
7 |
sdk_version: 2.9.0
|
|
|
8 |
app_file: app.py
|
9 |
pinned: true
|
10 |
---
|
@@ -24,11 +25,12 @@ View the demo at huggingface spaces:
|
|
24 |
|
25 |
Make sure you have the following tools installed:
|
26 |
|
|
|
27 |
- [Poetry](https://python-poetry.org/) for Python package management;
|
28 |
- [Docker](https://www.docker.com/get-started/) for running ElasticSearch.
|
29 |
-
- [Git LFS](https://git-lfs.github.com/) for downloading binary files that do not fit in git.
|
30 |
|
31 |
-
Then, run the following commands:
|
32 |
|
33 |
```sh
|
34 |
poetry install
|
@@ -40,7 +42,7 @@ docker run --name es01 --net elastic -p 9200:9200 -p 9300:9300 -it docker.elasti
|
|
40 |
After the last command, a password for the `elastic` user should show up in the
|
41 |
terminal output (you might have to scroll up a bit). Copy this password, and
|
42 |
create a copy of the `.env.example` file and rename it to `.env`. Replace the
|
43 |
-
`<password>` placeholder with your copied password.
|
44 |
|
45 |
Next, run the following command **from the root of the repository**:
|
46 |
|
@@ -48,10 +50,9 @@ Next, run the following command **from the root of the repository**:
|
|
48 |
docker cp es01:/usr/share/elasticsearch/config/certs/http_ca.crt .
|
49 |
```
|
50 |
|
|
|
51 |
|
52 |
-
|
53 |
-
|
54 |
-
https://www.elastic.co/cloud/
|
55 |
|
56 |
## Running
|
57 |
|
@@ -62,7 +63,7 @@ option, since it is much more convenient).
|
|
62 |
|
63 |
### Training
|
64 |
|
65 |
-
N/A for now
|
66 |
|
67 |
### Using the QA system
|
68 |
|
@@ -108,4 +109,15 @@ options:
|
|
108 |
```
|
109 |
|
110 |
|
111 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
5 |
colorTo: blue
|
6 |
sdk: gradio
|
7 |
sdk_version: 2.9.0
|
8 |
+
python_version: 3.10
|
9 |
app_file: app.py
|
10 |
pinned: true
|
11 |
---
|
|
|
25 |
|
26 |
Make sure you have the following tools installed:
|
27 |
|
28 |
+
- [Python](https://www.python.org/downloads/) ^3.10,<3.11
|
29 |
- [Poetry](https://python-poetry.org/) for Python package management;
|
30 |
- [Docker](https://www.docker.com/get-started/) for running ElasticSearch.
|
31 |
+
- [Git LFS](https://git-lfs.github.com/) for downloading binary files that do not fit in git.
|
32 |
|
33 |
+
Then, run the following commands to install dependencies and Elasticsearch:
|
34 |
|
35 |
```sh
|
36 |
poetry install
|
|
|
42 |
After the last command, a password for the `elastic` user should show up in the
|
43 |
terminal output (you might have to scroll up a bit). Copy this password, and
|
44 |
create a copy of the `.env.example` file and rename it to `.env`. Replace the
|
45 |
+
`<password>` placeholder with your copied password. The .env file can be used to change configuration of the system, leave it as is for a replication study.
|
46 |
|
47 |
Next, run the following command **from the root of the repository**:
|
48 |
|
|
|
50 |
docker cp es01:/usr/share/elasticsearch/config/certs/http_ca.crt .
|
51 |
```
|
52 |
|
53 |
+
**NOTE 1:** If docker is not available or feasable. It is possible to use a trail hosted version of Elasticsearch at: https://www.elastic.co/cloud/
|
54 |
|
55 |
+
**NOTE 2** Installing dependencies without poetry is possible, but it is not our recommendation. To do so execute `pip install -r requirements.txt`
|
|
|
|
|
56 |
|
57 |
## Running
|
58 |
|
|
|
63 |
|
64 |
### Training
|
65 |
|
66 |
+
N/A for now. The current version of the system does not require any
|
67 |
|
68 |
### Using the QA system
|
69 |
|
|
|
109 |
```
|
110 |
|
111 |
|
112 |
+
### Replicating the experiment
|
113 |
+
|
114 |
+
To fully run experiments, you need to run the following command:
|
115 |
+
|
116 |
+
```
|
117 |
+
# in the root of the project and poetry environment activated
|
118 |
+
python main.py
|
119 |
+
```
|
120 |
+
|
121 |
+
This command run all questions trough the system and stores the output to the `results/` directory.
|
122 |
+
|
123 |
+
After performing the experiment, results can be analyzed and displayed by running `plot.py` and the `results/*_analysis.ipynb` files.
|
pyproject.toml
CHANGED
@@ -5,7 +5,7 @@ description = ""
|
|
5 |
authors = ["Your Name <you@example.com>"]
|
6 |
|
7 |
[tool.poetry.dependencies]
|
8 |
-
python = "^3.
|
9 |
numpy = "^1.22.3"
|
10 |
transformers = "^4.17.0"
|
11 |
torch = "^1.11.0"
|
|
|
5 |
authors = ["Your Name <you@example.com>"]
|
6 |
|
7 |
[tool.poetry.dependencies]
|
8 |
+
python = "^3.10,<3.11"
|
9 |
numpy = "^1.22.3"
|
10 |
transformers = "^4.17.0"
|
11 |
torch = "^1.11.0"
|