update readme file
Browse files- .gitignore +1 -0
- README.md +38 -2
.gitignore
CHANGED
|
@@ -5,3 +5,4 @@ __pycache__/utils.cpython-38.pyc
|
|
| 5 |
|
| 6 |
notebooks/
|
| 7 |
*.pyc
|
|
|
|
|
|
| 5 |
|
| 6 |
notebooks/
|
| 7 |
*.pyc
|
| 8 |
+
local_tests/
|
README.md
CHANGED
|
@@ -1,16 +1,52 @@
|
|
| 1 |
---
|
| 2 |
title: esrsQ&A
|
| 3 |
-
emoji:
|
| 4 |
colorFrom: red
|
| 5 |
colorTo: indigo
|
| 6 |
sdk: gradio
|
| 7 |
sdk_version: 4.36.1
|
| 8 |
app_file: app.py
|
|
|
|
| 9 |
pinned: false
|
| 10 |
-
license: apache-2.0
|
| 11 |
hf_oauth: true
|
|
|
|
| 12 |
---
|
| 13 |
|
| 14 |
# ESRS Q&A
|
|
|
|
| 15 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 16 |
WIP
|
|
|
|
|
|
| 1 |
---
|
| 2 |
title: esrsQ&A
|
| 3 |
+
emoji: 🌱
|
| 4 |
colorFrom: red
|
| 5 |
colorTo: indigo
|
| 6 |
sdk: gradio
|
| 7 |
sdk_version: 4.36.1
|
| 8 |
app_file: app.py
|
| 9 |
+
fullWidth: true
|
| 10 |
pinned: false
|
|
|
|
| 11 |
hf_oauth: true
|
| 12 |
+
short_description: Ask any questions related to ESRS
|
| 13 |
---
|
| 14 |
|
| 15 |
# ESRS Q&A
|
| 16 |
+
In late 2022, Ekimetrics built ClimateQ&A, a tool to distill expert-level knowledge into easily digestible insights about climate science.
|
| 17 |
|
| 18 |
+
The European Corporate Sustainability Reporting Directive (CSRD) has entered into force from the 1st of January 2024 onwards. Inspired from ClimateQ&A, we have now built EsrsQ&A, a tool to distill European Sustainability Reporting Standards (ESRS).
|
| 19 |
+
|
| 20 |
+
## Table of Contents
|
| 21 |
+
- [Installation](#installation)
|
| 22 |
+
- [Usage](#usage)
|
| 23 |
+
- [Contributing](#contributing)
|
| 24 |
+
- [License](#license)
|
| 25 |
+
|
| 26 |
+
## Installation
|
| 27 |
+
1. Clone the repository (SSH):
|
| 28 |
+
```bash
|
| 29 |
+
git clone [email protected]:spaces/Ekimetrics/esrs-question-answering
|
| 30 |
+
```
|
| 31 |
+
|
| 32 |
+
2. Install dependencies:
|
| 33 |
+
```bash
|
| 34 |
+
poetry install
|
| 35 |
+
```
|
| 36 |
+
|
| 37 |
+
## Usage
|
| 38 |
+
To run the project, use the following command:
|
| 39 |
+
```bash
|
| 40 |
+
python app.py
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
## Contributing
|
| 44 |
+
1. Clone the repository.
|
| 45 |
+
2. Create a new branch: `git checkout -b feature-name`.
|
| 46 |
+
3. Make your changes.
|
| 47 |
+
4. Push your branch: `git push origin feature-name`.
|
| 48 |
+
5. Create a pull request.
|
| 49 |
+
|
| 50 |
+
## License
|
| 51 |
WIP
|
| 52 |
+
<!-- This project is licensed under the [MIT License](LICENSE). -->
|