Skip to content

Commit 830ef3b

Browse files
committed
feat(DEV): init README-DEV
1 parent afcb300 commit 830ef3b

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

README-DEV.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Implementation Details of 🎩Magicoder
2+
3+
> [!WARNING]
4+
> This document is a work in progress. It is not yet complete.
5+
6+
## Data Generation
7+
8+
Make sure you have set up your `OPENAI_API_KEY` and optionally `OPENAI_BASE_URL`. Then run with
9+
10+
```bash
11+
python src/magicoder/generate_data.py \
12+
--seed_code_start_index ${START_INDEX_OF_RAW_DATA} \
13+
--max_new_data ${MAX_DATA_TO_GENERATE} \
14+
--data_dir python \
15+
--tag python
16+
```
17+
18+
To continue an interrupted run, use `--continue_from` flag:
19+
20+
```bash
21+
python src/magicoder/generate_data.py \
22+
--seed_code_start_index ${START_INDEX_OF_RAW_DATA} \
23+
--max_new_data ${MAX_DATA_TO_GENERATE} \
24+
--data_dir python \
25+
--continue_from ${PATH_TO_DATA_FILE}
26+
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
</p>
1818

1919
> [!IMPORTANT]
20-
> We are keeping improving the documents and adding more implementation details. Please stay tuned!
20+
> We are keeping improving the documents and adding more implementation details. Please stay tuned at [README-DEV.md](README-DEV.md) for more information.
2121
2222
## About
2323

0 commit comments

Comments
 (0)