Skip to content
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.

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

Redesign the template of nplinker config file #206

Merged
merged 5 commits into from
Feb 27, 2024

Conversation

CunliangGeng
Copy link
Member

@CunliangGeng CunliangGeng commented Feb 23, 2024

This PR redesigned the template of nplinker config file nplinker.toml.

The new design does not allow users to specify the path to their data files, instead they should always put data files to default paths defined by NPLinker (the default paths will be provided in the next PR).

To keep it simple, some settings related to code that has not been refactored are not included in the new design. They can be added later if really needed.

Major changes:

  • redesign the template of config file nplinker.toml.
  • update default config values in nplinker_default.toml
  • add validations for all configs/settings
  • update unit tests for new configs/settings

Note: This PR only updated the template config file, but the usage of the configs in relevant code is not updated. Next PR will update the usage. So it's OK to see the failed test tests on tests/scorings and tests/test_nplinker_local.py .

The new design does not allow users to specify the path to their data files, instead they should always put data files to default paths defined by nplinker.

To keep it simple, some settings are removed in the new config template. They could be added later if really needed.
Copy link
Member Author

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

@CunliangGeng CunliangGeng added this to the refactor codebase milestone Feb 23, 2024
@CunliangGeng CunliangGeng marked this pull request as ready for review February 23, 2024 09:51
@CunliangGeng CunliangGeng self-assigned this Feb 23, 2024
Copy link
Contributor

@gcroci2 gcroci2 left a comment

Choose a reason for hiding this comment

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

I left a few comments/suggestions, but I guess that they are more for me to better understand what is going on :)

src/nplinker/data/nplinker.toml Show resolved Hide resolved
src/nplinker/config.py Show resolved Hide resolved
tests/data/nplinker_demo1.toml Show resolved Hide resolved
tests/conftest.py Show resolved Hide resolved
tests/test_config.py Show resolved Hide resolved
Copy link
Member Author

CunliangGeng commented Feb 27, 2024

Merge activity

@CunliangGeng CunliangGeng merged commit 0e7138b into dev Feb 27, 2024
6 of 7 checks passed
@CunliangGeng CunliangGeng deleted the refactor_config_template branch February 27, 2024 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants