Add your own model

Plug a new predictor into ALF by subclassing BaseModel. Once wrapped in a Surrogate (or an Oracle), it slots into the loop with no other changes.

Base class: BaseModel. Key methods: featurise, train, predict, sample.

A model can play three roles depending on which methods it implements and how it is used: a Surrogate (needs train + predict), an Oracle (needs predict), or a generator (needs sample). See Core Concepts for the roles.

Steps

1. Subclass BaseModel under tools/alf_tools/models/.

2. Implement featurise, train, predict, and sample as needed for the role.

3. Wrap it in a Surrogate (or Oracle) and pass it to a Task.

4. Add tests and run the build / pre-commit checks.

Reference notebooks

• Models: implement a custom BaseModel.

• Model roles: the surrogate / oracle / generator roles in detail.