Skip to content

Update README.md#7

Merged
JeremieGince merged 4 commits intodevfrom
fix_readme
Oct 15, 2025
Merged

Update README.md#7
JeremieGince merged 4 commits intodevfrom
fix_readme

Conversation

@JeremieGince
Copy link
Contributor

@JeremieGince JeremieGince commented Oct 15, 2025

Description

This pull request makes minor corrections to the example code in the README.md to ensure proper usage of PyTorch modules and dataset initialization.

  • PyTorch module usage:

    • Corrected the instantiation of the neural network by replacing torch.Sequential with torch.nn.Sequential in the LinearNN class.
  • Dataset initialization:

    • Updated the creation of the datamodule to explicitly specify fold_id=0 when calling DataModule.from_dataset_name, ensuring deterministic data splits.

Checklist

Please complete the following checklist when submitting a PR. The PR will not be reviewed until all items are checked.

  • All new features include a unit test.
    Make sure that the tests passed and the coverage is
    sufficient by running pytest tests --cov=src --cov-report=term-missing.
  • All new functions and code are clearly documented.
  • The code is formatted using Black.
    You can do this by running black src tests.
  • The imports are sorted using isort.
    You can do this by running isort src tests.
  • The code is type-checked using Mypy.
    You can do this by running mypy src tests.

Reduced DEFAULT_INNER_MAX_EPOCHS from 10,000 to 1,024 and DEFAULT_INNER_MAX_TIME from 90 hours to 1 hour in AutoMLPipeline. This likely aims to shorten training runs for faster experimentation or testing.
@github-actions
Copy link

github-actions bot commented Oct 15, 2025

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
685 675 99% 90% 🟢

New Files

No new covered files...

Modified Files

File Coverage Status
src/matchcake_opt/tr_pipeline/automl_pipeline.py 96% 🟢
TOTAL 96% 🟢

updated for commit: 6d0ed02 by action🐍

Updated the README to include guidance on installing the package with CUDA support by using the `--extra cu128` flag.
@JeremieGince JeremieGince merged commit f57ed2e into dev Oct 15, 2025
6 checks passed
@JeremieGince JeremieGince deleted the fix_readme branch October 15, 2025 13:31
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.

1 participant