docs: update README
Browse files
README.md
CHANGED
|
@@ -1,4 +1,3 @@
|
|
| 1 |
-
|
| 2 |
# LLMDataParser
|
| 3 |
|
| 4 |
**LLMDataParser** is a Python library that provides parsers for benchmark datasets used in evaluating Large Language Models (LLMs). It offers a unified interface for loading and parsing datasets like **MMLU** and **GSM8k**, simplifying dataset preparation for LLM evaluation.
|
|
@@ -18,16 +17,16 @@ You can install the package directly using `pip`. Even with only a `pyproject.to
|
|
| 18 |
|
| 19 |
1. **Clone the Repository**:
|
| 20 |
|
| 21 |
-
|
| 22 |
-
|
| 23 |
-
|
| 24 |
-
|
| 25 |
|
| 26 |
2. **Install Dependencies with pip**:
|
| 27 |
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
|
| 31 |
|
| 32 |
### Option 2: Using Poetry
|
| 33 |
|
|
@@ -35,25 +34,19 @@ Poetry manages the virtual environment and dependencies automatically, so you do
|
|
| 35 |
|
| 36 |
1. **Install Dependencies with Poetry**:
|
| 37 |
|
| 38 |
-
|
| 39 |
-
|
| 40 |
-
|
| 41 |
|
| 42 |
2. **Activate the Virtual Environment**:
|
| 43 |
|
| 44 |
-
|
| 45 |
-
|
| 46 |
-
|
| 47 |
-
|
| 48 |
|
| 49 |
## Available Parsers
|
| 50 |
|
| 51 |
-
- **
|
| 52 |
-
- **GSM8kParser**: Parses the GSM8k dataset.
|
| 53 |
-
|
| 54 |
-
## Contributing
|
| 55 |
-
|
| 56 |
-
Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
|
| 57 |
|
| 58 |
## License
|
| 59 |
|
|
@@ -61,4 +54,4 @@ This project is licensed under the MIT License. See the [LICENSE](LICENSE) file
|
|
| 61 |
|
| 62 |
## Contact
|
| 63 |
|
| 64 |
-
For questions or support, please open an issue on GitHub or contact [
|
|
|
|
|
|
|
| 1 |
# LLMDataParser
|
| 2 |
|
| 3 |
**LLMDataParser** is a Python library that provides parsers for benchmark datasets used in evaluating Large Language Models (LLMs). It offers a unified interface for loading and parsing datasets like **MMLU** and **GSM8k**, simplifying dataset preparation for LLM evaluation.
|
|
|
|
| 17 |
|
| 18 |
1. **Clone the Repository**:
|
| 19 |
|
| 20 |
+
```bash
|
| 21 |
+
git clone https://github.com/jeff52415/LLMDataParser.git
|
| 22 |
+
cd LLMDataParser
|
| 23 |
+
```
|
| 24 |
|
| 25 |
2. **Install Dependencies with pip**:
|
| 26 |
|
| 27 |
+
```bash
|
| 28 |
+
pip install .
|
| 29 |
+
```
|
| 30 |
|
| 31 |
### Option 2: Using Poetry
|
| 32 |
|
|
|
|
| 34 |
|
| 35 |
1. **Install Dependencies with Poetry**:
|
| 36 |
|
| 37 |
+
```bash
|
| 38 |
+
poetry install
|
| 39 |
+
```
|
| 40 |
|
| 41 |
2. **Activate the Virtual Environment**:
|
| 42 |
|
| 43 |
+
```bash
|
| 44 |
+
poetry shell
|
| 45 |
+
```
|
|
|
|
| 46 |
|
| 47 |
## Available Parsers
|
| 48 |
|
| 49 |
+
- **MMLUDatasetParser**: Parses the MMLU dataset.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 50 |
|
| 51 |
## License
|
| 52 |
|
|
|
|
| 54 |
|
| 55 |
## Contact
|
| 56 |
|
| 57 |
+
For questions or support, please open an issue on GitHub or contact [jeff52415@gmail.com](mailto:jeff52415@gmail.com).
|