Skip to content

feat(projects): Add comprehensive example projects #176

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

Merged
ibro45 merged 61 commits into from
Dec 9, 2025
Merged

feat(projects): Add comprehensive example projects #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
7719988
Update github workflows
ibro45 Nov 16, 2025
9c0db7f
Rename LighterConfig to ConfigSchema
ibro45 Nov 16, 2025
1682354
Improve github workflows. Add mkdocs extensions
ibro45 Nov 17, 2025
317021d
Improve type annotations throughout the codebase
ibro45 Nov 17, 2025
41dc125
Refactor System mode detection to use trainer state
ibro45 Nov 17, 2025
7725982
Simplify Runner CLI to leverage Sparkwheel auto-detection
ibro45 Nov 17, 2025
7e99a8b
Update dependencies and GitHub workflow configuration
ibro45 Nov 17, 2025
58c55c3
Update System design documentation
ibro45 Nov 17, 2025
8e29a75
Update tests to match refactored CLI and System changes
ibro45 Nov 17, 2025
0d7bf12
Refactor core architecture: replace System with Model and Data modules
ibro45 Nov 23, 2025
6425f46
Refactor callback system: consolidate writers into flat structure
ibro45 Nov 23, 2025
a9f7330
Simplify Runner and remove schema module
ibro45 Nov 23, 2025
f1825e3
Update CIFAR10 example for new architecture
ibro45 Nov 23, 2025
be149e9
Update test suite for new architecture
ibro45 Nov 23, 2025
c8704cc
Rewrite documentation for new architecture
ibro45 Nov 23, 2025
17d5691
Update project configuration and CI/CD
ibro45 Nov 23, 2025
f1a1520
docs: enhance configuration guide and logging documentation
ibro45 Nov 24, 2025
37da1d0
refactor: require MetricCollection wrapper for multiple metrics
ibro45 Nov 24, 2025
926ff14
test: add comprehensive DDP testing with mock-based approach
ibro45 Nov 24, 2025
d854e52
Add codecov yml
ibro45 Nov 25, 2025
e54c071
chore: improve project configuration
ibro45 Nov 27, 2025
6bc6351
refactor(runner): streamline config management and CLI architecture
ibro45 Nov 27, 2025
173eb84
feat(data): add max_retries parameter to collate_replace_corrupted
ibro45 Nov 27, 2025
2bdbcb4
refactor: remove unused utilities and update comments
ibro45 Nov 27, 2025
3f8a002
docs: improve examples and clarify multi-GPU behavior
ibro45 Nov 27, 2025
5c71150
test: update test suite for runner refactoring
ibro45 Nov 27, 2025
072b449
Refactor config saving in Runner
ibro45 Nov 28, 2025
4c8e955
Fix tests after removing _save_hyperparameters
ibro45 Nov 29, 2025
78733a4
Remove unneeded files
ibro45 Nov 29, 2025
1443fe5
docs: improve configuration examples and clarify _disabled_ behavior
ibro45 Dec 1, 2025
987c320
chore: update .gitignore patterns
ibro45 Dec 1, 2025
1309ae2
fix: register module in sys.modules before execution
ibro45 Dec 1, 2025
9958d0d
docs: add projects overview README
ibro45 Dec 1, 2025
bb0c017
chore: update .gitignore to track example projects
ibro45 Dec 1, 2025
c6870c9
feat(projects): add cifar10 image classification example
ibro45 Dec 1, 2025
3b8b16c
feat(projects): add huggingface_llm text classification example
ibro45 Dec 1, 2025
a43b3a4
feat(projects): add medical_segmentation MONAI example
ibro45 Dec 1, 2025
d5a03a1
feat(projects): add self_supervised SimCLR example
ibro45 Dec 1, 2025
d1e9048
feat(projects): add video_recognition action classification example
ibro45 Dec 1, 2025
d2d57dd
feat(projects): add eeg NeurIPS 2025 Challenge example
ibro45 Dec 1, 2025
3b65f73
feat(projects): add vision_language CLIP example
ibro45 Dec 1, 2025
e2bc589
feat(projects): add efficient_finetuning LoRA example
ibro45 Dec 1, 2025
8457b27
refactor(cifar10): remove deprecated model files
ibro45 Dec 1, 2025
b13354c
chore(video_recognition): add .gitignore for datasets folder
ibro45 Dec 1, 2025
58f78fb
chore: simplify projects gitignore rules
ibro45 Dec 5, 2025
54ffe5b
refactor(projects): rename efficient_finetuning to lora with PEFT
ibro45 Dec 5, 2025
49da0dd
docs(projects): simplify READMEs and standardize install instructions
ibro45 Dec 5, 2025
c11fd0e
refactor(eeg): make num_workers configurable via vars
ibro45 Dec 5, 2025
5a2594c
refactor(medical_segmentation): inline transforms and use ITKWriter
ibro45 Dec 5, 2025
aa5e567
refactor(self_supervised): enhance SimCLR implementation
ibro45 Dec 5, 2025
fa9c4af
refactor(huggingface_llm): remove default batch limits
ibro45 Dec 5, 2025
d874538
refactor(video_recognition): clean up unused code
ibro45 Dec 5, 2025
f4db6ab
refactor(vision_language): clean up unused code
ibro45 Dec 5, 2025
82eb54e
docs: update example projects section with additional details
ibro45 Dec 6, 2025
801455e
docs: add index for example projects and update references
ibro45 Dec 9, 2025
0702c65
Merge main into projects branch
ibro45 Dec 9, 2025
15b08e8
refactor: clean up unused modules and update model references across …
ibro45 Dec 9, 2025
02feb2b
refactor: update .gitignore
ibro45 Dec 9, 2025
7b529d0
fix: add validation for valid_frac and test_frac in dataset classes; …
ibro45 Dec 9, 2025
10d3cf8
feat: enhance dataset classes with split filtering and validation; ad…
ibro45 Dec 9, 2025
26f4227
refactor: update pull request template
ibro45 Dec 9, 2025
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
17 changes: 9 additions & 8 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## Description

<!-- Add a more detailed description of the changes if needed. -->
<!-- Briefly describe what this PR does and why. -->

## Related Issue

<!-- If your PR refers to a related issue, link it here. -->
<!-- Link any related issues: Fixes #123, Closes #456 -->

## Type of Change

<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->

- [ ] 📚 Examples / docs / tutorials / dependencies update
- [ ] 📚 Documentation / examples / dependencies update
- [ ] 🔧 Bug fix (non-breaking change which fixes an issue)
- [ ] 🥂 Improvement (non-breaking change which improves an existing feature)
- [ ] 🚀 New feature (non-breaking change which adds functionality)
Expand All @@ -21,8 +21,9 @@

<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->

- [ ] I've read the [`CODE_OF_CONDUCT.md`](https://github.com/lighter/lighter/blob/master/CODE_OF_CONDUCT.md) document.
- [ ] I've read the [`CONTRIBUTING.md`](https://github.com/lighter/lighter/blob/master/CONTRIBUTING.md) guide.
- [ ] I've updated the code style using `make codestyle`.
- [ ] I've written tests for all new methods and classes that I created.
- [ ] I've written the docstring in Google format for all the methods and classes that I used.
- [ ] I've read the [`CONTRIBUTING.md`](https://github.com/project-lighter/lighter/blob/main/CONTRIBUTING.md) guide
- [ ] Code passes linting: `just lint`
- [ ] Code passes type checking: `just types`
- [ ] All tests pass with coverage: `just coverage`
- [ ] I've added tests for new functionality
- [ ] I've updated documentation if needed
14 changes: 3 additions & 11 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,29 +145,21 @@ tensorboard/

# ---- Our ignores ----
**/.DS_Store
**/predictions/
test_dir/
checkpoints/
prototyping*
.aider*
*.code-workspace
.scale_batch_size*
**/*.txt
.ruff_cache
cifar10/

# Paper
paper/jats/


# Coding agents
CLAUDE.md
GEMINI.md
AGENTS.md

**/.claude/

# Outputs, logs, dataset files
**/lightning_logs/
**/outputs/
**/.datasets/
**/*.zip
**/predictions/
checkpoints/
Comment on lines +159 to +165
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Dec 9, 2025

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Inconsistent pattern for checkpoints directory matching.

Lines 160–164 all use the **/ prefix for recursive directory matching, but line 165 uses only checkpoints/. This will only ignore root-level checkpoints, not those in example project subdirectories. Since the PR adds multiple projects that may generate their own checkpoints directories, this inconsistency could cause unintended file tracking.

Apply this diff for consistency:

 # Outputs, logs, dataset files
 **/lightning_logs/
 **/outputs/
 **/.datasets/
 **/*.zip
 **/predictions/
-checkpoints/
+**/checkpoints/
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Outputs, logs, dataset files
**/lightning_logs/
**/outputs/
**/.datasets/
**/*.zip
**/predictions/
checkpoints/
# Outputs, logs, dataset files
**/lightning_logs/
**/outputs/
**/.datasets/
**/*.zip
**/predictions/
**/checkpoints/
🤖 Prompt for AI Agents 
In .gitignore around lines 159 to 165, the pattern for ignoring checkpoints is
inconsistent (other entries use **/ but line 165 uses only checkpoints/), so
update that line to use the recursive pattern (e.g., change checkpoints/ to
**/checkpoints/) so checkpoints directories in subprojects are also ignored;
ensure the updated pattern matches the style used by the surrounding entries.

Loading
Loading