Skip to content

Commit c1ef86e

Browse files
committed
feat(readme): add a simple readme and comment the swanlab link
1 parent 9e6ac1d commit c1ef86e

3 files changed

Lines changed: 73 additions & 9 deletions

File tree

.env.example

Whitespace-only changes.

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,66 @@
11
# SpectrumLab
22

3+
<div align="center">
4+
A pioneering unified platform designed to systematize and accelerate deep learning research in spectroscopy.
5+
</div>
6+
7+
## Quick Start
8+
9+
### Environment Setup
10+
11+
We recommend using conda and uv for environment management:
12+
13+
```bash
14+
# Clone the repository
15+
git clone https://github.com/your-org/SpectrumLab.git
16+
cd SpectrumLab
17+
18+
# Create conda environment
19+
conda create -n spectrumlab python=3.10
20+
conda activate spectrumlab
21+
22+
pip install uv
23+
uv pip install -e .
24+
```
25+
26+
### One-Click Evaluation
27+
28+
1. **Switch to evaluation branch**
29+
30+
```bash
31+
git checkout evaluation
32+
```
33+
34+
2. **Download benchmark data**
35+
36+
Benchmark data is hosted on Hugging Face. Please download it from the following link:
37+
38+
[https://huggingface.co/datasets/SpectrumWorld/spectrumbench_v_1.0](https://huggingface.co/datasets/SpectrumWorld/spectrumbench_v_1.0)
39+
40+
After downloading, extract the data to the `data` directory in the project root.
41+
42+
3. **Configure model parameters**
43+
44+
```bash
45+
# Copy and edit environment configuration
46+
cp .env.example .env
47+
# Configure your API keys in the .env file
48+
```
49+
50+
4. **Run evaluation**
51+
52+
```bash
53+
python run_evaluation.py
54+
55+
# Run in background
56+
nohup python run_evaluation.py > run_eval.log 2>&1 &
57+
```
58+
59+
## 🤝 Contributing
60+
61+
We welcome community contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
62+
63+
## Acknowledgments
64+
65+
- **Experiment Tracking**: [SwanLab](https://github.com/SwanHubX/SwanLab/) for experiment management and visualization
66+
- **Evaluation Framework**: Inspired by [MMAR](https://github.com/ddlBoJack/MMAR)

run_evaluation.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
import swanlab
1+
# import swanlab
22
from spectrumlab.models import GPT4_1
33
from spectrumlab.benchmark.signal_group import SignalGroup
44
from spectrumlab.benchmark.generation_group import GenerationGroup
@@ -46,12 +46,12 @@
4646
]
4747

4848
# Change the experiment_name to your model name!!!
49-
swanlab.init(
50-
workspace="SpectrumLab",
51-
project="spectrumlab-eval",
52-
experiment_name="gpt_4_1_generation_evaluation_results",
53-
config={"model": MODEL.model_name},
54-
)
49+
# swanlab.init(
50+
# workspace="SpectrumLab",
51+
# project="spectrumlab-eval",
52+
# experiment_name="gpt_4_1_generation_evaluation_results",
53+
# config={"model": MODEL.model_name},
54+
# )
5555

5656
for group_info in GROUPS:
5757
name = group_info["name"]
@@ -63,9 +63,9 @@
6363
results = evaluator.evaluate(data_items=data, model=MODEL, save_path=SAVE_DIR)
6464
accuracy = results["metrics"]["overall"]["accuracy"]
6565
print(f"{name} Group evaluation completed! Overall accuracy: {accuracy:.2f}%\n")
66-
swanlab.log({f"{name}_accuracy": accuracy})
66+
# swanlab.log({f"{name}_accuracy": accuracy})
6767

68-
swanlab.finish()
68+
# swanlab.finish()
6969

7070
# use nohup in the terminal to start the evaluation
7171
# nohup python run_evaluation.py > run_eval.log 2>&1 &

0 commit comments

Comments
 (0)