google / orbax

Orbax provides common checkpointing and persistence utilities for JAX users
https://orbax.readthedocs.io/
Apache License 2.0
303 stars 36 forks source link

AttributeError: module 'orbax.checkpoint.metadata' has no attribute 'Metadata' #1294

Open hanzhi713 opened 2 weeks ago

hanzhi713 commented 2 weeks ago

After upgrading orbax to 0.8.0, I encountered this error.

Also documentation also broke: https://orbax.readthedocs.io/en/latest/guides/checkpoint/custom_handlers.html

hanzhi713 commented 2 weeks ago

Looks like this Metadata class needs to be imported like

from orbax.checkpoint._src.metadata.value import Metadata

Shouldn't this be in the user-facing API?

cpgaffney1 commented 2 weeks ago

Thanks for spotting, our tests that are supposed to catch docs breakages appear not to be working. Will fix ASAP.