Structured Configs and the Compose API

[JakartaLaw]

I am currently using Hydra in conjunction with notebooks (or IPykernels to be specific) to configure a data science project.

At the moment I use the dictionary object when using the compose API. However, I would like to use the compose api and still be able to make a structured config. Is this currently a feature, and I just can find it in the documentation?

What i would like to be able to do:

with initialize(config_path="../conf"):
    cfg = compose(config_name="config")

and having cfg being a structured config object?

[Jasha10]

Hi @JakartaLaw, sorry for the late reply.
Yes, you can use structured configs with the compose API.
You can follow the same steps for structured config with the hydra.main API:

• Define some structured config dataclasses
• use the ConfigStore.store method to store your structured configs
• use the compose API to create a structured config object