Update sft_datasets.md #1349
Merged
Update sft_datasets.md #1349
Conversation
This file contains hidden or 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
Updated the documentation for sft_datasets with more precise instructions for how to add a new dataset and how to override dataset_name to utilize existing datasets.
taenin
reviewed
Feb 3, 2025
| @@ -72,6 +72,7 @@ To add a new SFT dataset: | |||
|
|
|||
| 1. Subclass {py:class}`~oumi.core.datasets.BaseSftDataset` | |||
| 2. Implement the {py:meth}`~oumi.core.datasets.BaseSftDataset.transform_conversation` method to define the dataset-specific transformation logic. | |||
| 3. Register your new dataset to the dataset class by adding it to {py:class}`~oumi.core.datasets.__init__.py` and {py:class}`~oumi.datasets.sft.__init__.py`. | |||
There was a problem hiding this comment.
Does {py:class} work properly when referencing an __init__.py file?
There was a problem hiding this comment.
Nope, good catch. Refactored to {py:mod}
taenin
approved these changes
Feb 3, 2025
nikg4
reviewed
Feb 3, 2025
| @@ -110,6 +111,18 @@ class CustomSftDataset(BaseSftDataset): | |||
| For more advanced SFT dataset implementations, explore the `oumi.datasets` module, which contains implementations of several [open source datasets](https://github.com/oumi-ai/oumi/tree/main/src/oumi/datasets). | |||
| ``` | |||
|
|
|||
| ### Using an Unregistered Dataset Whose Format is Identical to a Registered Dataset | |||
|
|
|||
| Many datasets on HuggingFace share the same format as Oumi registered datasets. It is not necessary to register each dataset explicitly to use it. Instead, you can override the `dataset_name` parameter. | |||
There was a problem hiding this comment.
should we say ... dataset_name_override: kwargs parameter or somesuch for extra clarity?
There was a problem hiding this comment.
Thanks @xrdaukar, I added a bit more text here to make it clear that users should refer to the example for further clarification.
nikg4
approved these changes
Feb 3, 2025
Corrected Sphinx roles
Clarified description
oelachqar
approved these changes
Feb 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the documentation for sft_datasets with more precise instructions for how to add a new dataset and how to override dataset_name to utilize existing datasets.
Related issues
Fixes # (issue)
Before submitting
Reviewers
At least one review from a member of
oumi-ai/oumi-staffis required.