-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Costa Shulyupin <[email protected]>
- Loading branch information
Showing
1 changed file
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
# Wiki document source | ||
|
||
Fetching information from wikis is an essential | ||
feature for fine-tuning LLMs on public knowledge. | ||
|
||
## Interfaces | ||
|
||
qna.yaml file, `document` section: | ||
|
||
- Wiki Host: The base URL of a wiki host. | ||
- Page titles: The titles of the Wiki pages to fetch. | ||
- oldid: IDs of old releases. | ||
|
||
The qna.yaml file can define single host and multiple spaces and pages, | ||
each with an optional version. | ||
|
||
Example of fetch URL: | ||
|
||
- https://en.wikipedia.org/w/index.php?title=IBM_Granite&oldid=1235007056&action=raw | ||
|
||
Note that oldid is sufficient to reterieve a page: | ||
|
||
- https://en.wikipedia.org/w/index.php?oldid=1235007056&action=raw | ||
|
||
Page title is used for vaidation. | ||
|
||
## Changes across modules | ||
|
||
- [Schema module](https://github.com/instructlab/schema) defines the structure and validation rules for | ||
the qna.yaml file. | ||
- [SDG taxonomy module](https://github.com/instructlab/sdg/blob/main/src/instructlab/sdg/utils/taxonomy.py) | ||
fetches documents | ||
- [SDG unit tests](https://github.com/instructlab/sdg/tree/main/tests) | ||
|
||
## Additional External Packages | ||
|
||
- urllib | ||
|