WSMF
tl;dr
This package contains implementations of two novel approaches to warm-starting encoder-based warm-start of the Bayesian Hyperparameter Optimization. It allows both training and using meta-models which can help in this meta-task.
Contents
Meta-models - As for now it contains two approaches to encoder-based warm-start:
- Metric learning (
Dataset2VecMetricLearning) - As an encoder it uses Dataset2Vec which is trained in a way that it produces representations whose distances to each other correspond to distances of the landmarkers (vectors of performances of a predefined set of hyperparameter configuration) - Landmarker reconstruction (
LandmarkerReconstructionTrainingInterface) - As an encoder it uses Dataset2Vec which produces a latent representation of the entire dataset (of any size) and passes it to MLP which outputs predictions of the landmarker vector
Selectors - for usage for this intended meta-task wsmf provides API to use encoder for proposing hyperparameter configuration. It contains the following samplers:
- Selector which is choosing based on the learned representation that is applicable in the metric learning approach (
RepresentationBasedHpSelector) - Selector which is based on the reconstructed landmarkers (
ReconstructionBasedHpSelector) - Random selector from the predefined portfolio (
RandomHpSelector) - Selector which chooses the best configuration on average (
RankBasedHpSelector) - Selector that chooses configurations based on the vector of landmarkers itself (
LandmarkerHpSelector)
Examples of usage
Training metric learning based meta-model
# tensors X, y are torch.Tensor objects which correspond to feature and target matrices
train_datasets = { # training meta-dataset
"dataset_train_1": (tensor_X1, tensor_y1),
"dataset_train_2": (tensor_X2, tensor_y2),
...
}
val_datasets = { # validation meta-dataset
"dataset_val_1": (tensor_X1, tensor_y1),
"dataset_val_2": (tensor_X2, tensor_y2),
...
}
# tensors l1, l2, .. corresponds to vector of landmarkers in torch.Tensor format
train_landmarkers = { # training meta-dataset
"dataset_train_1": l1,
"dataset_train_2": l2,
...
}
val_landmarkers = { # validation meta-dataset
"dataset_val_1": l1,
"dataset_val_2": l2,
...
}
train_dataset = EncoderHpoDataset(train_datasets, train_landmarkers)
train_dataloader = EncoderMetricLearningLoader(train_dataset, train_num_batches, train_batch_size)
val_dataset = EncoderHpoDataset(val_datasets, val_landmarkers)
val_dataloader = EncoderMetricLearningLoader(val_dataset, val_num_batches, val_batch_size)
val_dataloader = GenericRepeatableDataLoader(val_dataloader) # Loader which produces repeatable batches
model = Dataset2VecMetricLearning()
trainer = pl.Trainer()
trainer.fit(model, train_loader, val_loader)
Using selector based on reconstruction
datasets = { # datasets to search from (in this case used for closest dataset search)
"dataset_1": (tensor_X1, tensor_y1),
"dataset_2": (tensor_X2, tensor_y2),
...
}
landmarkers = { # landmarkers to search from (is this case used for proposing best configurations)
"dataset_val_1": l1,
"dataset_val_2": l2,
...
}
configurations = [
{"hp1": val1, "hp2": val2},
{"hp1": val3, "hp2": val4},
...
]
meta_model = Dataset2VecForLandmarkerReconstruction.load_from_checkpoint("path_to_meta_model.ckpt")
selector = ReconstructionBasedHpSelector(
meta_model,
datasets,
landmarkers,
configurations
)
# Usage
new_dataset = (X, y) # torch.Tensor
n_configurations = 10
configurations = selector.propose_configurations(new_dataset, n_configurations)
Development
Commands useful during development:
- Seting env variables -
export PYTHONPATH=(backtick)pwd(backtick) - Install dependencies -
pip install -r requirements_dev.txt - To run unit tests -
pytest - Check code quality -
./scripts/check_code.sh - Relase -
python -m build && twine upload dist/*
Metadata
Release files for wsmf 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| wsmf-0.0.2.tar.gz | 40.7 kB | Without provenance | Details for wsmf-0.0.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| wsmf-0.0.2-py3-none-any.whl | Python 3 | none | any | Details for wsmf-0.0.2-py3-none-any.whl |
Total release size: 56.0 kB
Release files / wsmf-0.0.2.tar.gz
| Download URL | wsmf-0.0.2.tar.gz |
|---|---|
| Size | 40.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1966063a19ed4b845c15aac77960ebee26a8b6db95eb99f59aa912e1cbd6b5a8
|
|
BLAKE2b-256 checksum How to use checksums |
30f279c8e2ea3668f6246d98f9ce214b12fa465a48ae960265c4140f1270a40e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.12
|
Release files / wsmf-0.0.2-py3-none-any.whl
| Download URL | wsmf-0.0.2-py3-none-any.whl |
|---|---|
| Size | 15.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
58028e13448fe28e30f1f47ed45d52aa77567fc34f0b20c2d3a4ec4a12d27312
|
|
BLAKE2b-256 checksum How to use checksums |
5254fc1e91001ad8cf9905d845b5df77ea6512df862536f7fa1c351ab4bbfe9c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.0.0 CPython/3.10.12
|
Security for wsmf 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.