Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
79 lines (55 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

79 lines (55 loc) · 2.33 KB

Contributor Guidelines

🤗Contributors

Contributors

🌟 How to Contribute

We welcome contributions from the community! There are several ways to contribute:

New Features

If you'd like to implement a new feature:

  1. First open a feature request issue to discuss your proposal with committers
  2. After approval, implement your feature and submit a pull request

🐞 Bug Fixes

For bug fixes:

  • Submit a pull request with a clear description of the bug
  • Include steps to reproduce if applicable
  • If unsure whether something is a bug, open an issue first

➕ Adding New Methods

To add new methods to the codebase:

For methods similar to MLP (only model design needed):

  1. Add model class in model/models/
  2. Inherit from model/methods/base.py and override construct_model()
  3. Add method name in get_method() function in model/utils.py
  4. Add parameter settings in:
    • configs/default/[MODEL_NAME].json
    • configs/opt_space/[MODEL_NAME].json

For methods requiring training process changes:

  • Partially override functions from model/methods/base.py
  • Refer to existing implementations in model/methods/

Committer

  • Si-Yang Liu

🏁 Getting Started

Installation

pip install git+https://github.com/LAMDA-Tabular/TALENT.git@main --upgrade

Running Experiments

  1. Edit configuration files:

    • configs/default/[MODEL_NAME].json
    • configs/opt_space/[MODEL_NAME].json

  2. Run:

# For deep methods
python train_model_deep.py --model_type MODEL_NAME

# For classical methods
python train_model_classical.py --model_type MODEL_NAME

📬 Contact

For questions or feature proposals: