Skip to content

Add Quick Start section to README for easier onboarding #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kamran-khalid-v9 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Quick Start section to README for easier onboarding #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,36 @@ Also, I developing the general experimental framework I created for LLM research

---

## Quick Start

To get started quickly with this project:

1. **Clone the repository:**
```bash
git clone https://github.com/LuckyOne7777/LLM-Trading-Lab.git
cd LLM-Trading-Lab
```

2. **Install dependencies:**
```bash
pip install -r requirements.txt
```

3. **Run the trading script (example):**
```bash
python Experiments/chatgpt_micro-cap/scripts/processing/trading_script.py --file "Experiments/chatgpt_micro-cap/csv_files/Daily_Updates.csv"
```
- You can specify your own CSV file with the `--file` argument.

4. **Explore research and results:**
- See the `Experiments/chatgpt_micro-cap/evaluation/` folder for reports and papers.
- Check `Experiments/chatgpt_micro-cap/collected_artifacts/` for research logs and summaries.

5. **Contribute:**
- See [Other/CONTRIBUTING.md](Other/CONTRIBUTING.md) for how to report issues or submit pull requests.

---

## Contributing

Contributions are welcome.
Expand Down