Skip to content

Datasets license; swarm readme update [skip ci] (#4303)#4305

Open
holgerroth wants to merge 1 commit intoNVIDIA:mainfrom
holgerroth:datasets_license
Open

Datasets license; swarm readme update [skip ci] (#4303)#4305
holgerroth wants to merge 1 commit intoNVIDIA:mainfrom
holgerroth:datasets_license

Conversation

@holgerroth
Copy link
Collaborator

Fixes # .

Description

Cherry-pick #4303

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Quick tests passed locally by running ./runtest.sh.
  • In-line docstrings updated.
  • Documentation updated.

Fixes # .

Description

A few sentences describing the changes proposed in this pull request.

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Quick tests passed locally by running ./runtest.sh.
  • In-line docstrings updated.
  • Documentation updated.

Fixes # .

### Description

Add datasets 3rd party license; swarm readme update

### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] Non-breaking change (fix or new feature that would not break
existing functionality).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [ ] New tests added to cover the changes.
- [ ] Quick tests passed locally by running `./runtest.sh`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated.
@holgerroth holgerroth enabled auto-merge (squash) March 12, 2026 19:10
@holgerroth
Copy link
Collaborator Author

/build

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 12, 2026

Greptile Summary

This PR cherry-picks two documentation/license changes from PR #4303: it adds a third-party Apache 2.0 license file for the Hugging Face datasets library and expands the swarm learning README.md from a bare redirect link into a proper landing page.

Key observations:

  • 3rdParty/datasets.LICENSE.txt: Standard Apache 2.0 license text, consistent with the other license files already in 3rdParty/. No issues.
  • examples/advanced/swarm_learning/README.md: The new README references ./swarm_pt/ and ./swarm_pt/README.md as an existing example, but no swarm_pt subdirectory exists anywhere under examples/advanced/swarm_learning/. Both links will be dead until the directory is added in a separate PR. The relative paths to the self-paced-training tutorials (../../tutorials/self-paced-training/…) are valid and resolve correctly.

Confidence Score: 4/5

  • Safe to merge with one minor documentation concern: the swarm_pt subdirectory referenced in the README does not yet exist.
  • Both changes are documentation/license files with no runtime impact. The only issue is a broken link to a directory that hasn't been committed yet, which doesn't affect any code functionality but will confuse readers browsing the README.
  • examples/advanced/swarm_learning/README.md — references a swarm_pt example directory that does not exist in the repository.

Important Files Changed

Filename Overview
3rdParty/datasets.LICENSE.txt Adds the standard Apache 2.0 license file for the Hugging Face datasets third-party library. No issues found.
examples/advanced/swarm_learning/README.md Expands the README from a one-liner redirect into a proper landing page. References ./swarm_pt/ and ./swarm_pt/README.md which do not exist in the repository, resulting in two dead links. The relative paths to the self-paced-training tutorials and README are valid.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[examples/advanced/swarm_learning/README.md] --> B["./swarm_pt/ ❌ (does not exist)"]
    A --> C["./swarm_pt/README.md ❌ (does not exist)"]
    A --> D["../../tutorials/self-paced-training/part-4.../chapter-7... ✅"]
    A --> E["../../tutorials/self-paced-training/README.md ✅"]
Loading

Last reviewed commit: a8a1c26


## Examples

- **[swarm_pt](./swarm_pt/)** — Swarm learning with LoRA fine-tuning: fine-tune a Qwen2.5 language model using LoRA adapters in a federated setting. See the [swarm_pt README](./swarm_pt/README.md) for setup and run instructions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Broken link to non-existent swarm_pt directory

The README references ./swarm_pt/ and ./swarm_pt/README.md, but the swarm_pt subdirectory does not exist in the repository — the only file under examples/advanced/swarm_learning/ is this README.md itself. Both links on this line will be dead.

If the swarm_pt example is being added in a follow-up PR, it would be safer to add this entry to the README at the same time as the directory, or add a note that the directory is coming soon to avoid confusing readers in the interim.

@holgerroth
Copy link
Collaborator Author

/build

@holgerroth
Copy link
Collaborator Author

@chesterxgchen let's merge the swarm_pt example into main before merging this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants