Add ability to load class instances from json config string, not just a file #881
Assignees
Comments
3 tasks
bpkroth
added a commit
that referenced
this issue
Dec 6, 2024
…for tunables (#890) # Pull Request ## Title Allow loading configs from JSON strings not just files and add docs for Tunables to demonstrate and test it. --- ## Description Adds basic support for loading a JSON config string directly. The main purpose is to be able to show examples in docstrings that are testable (so that they don't become stale examples). - [x] Add basic example of usage and testing in a tunables docstring example. - [x] Add `pytest` unit tests for config string loading as well (we already have file loading tests). - Closes #881 --- ## Type of Change - ✨ New feature - 📝 Documentation update - 🧪 Tests --- ## Testing - [x] Adds additional unit tests. --- ## Additional Notes (optional) Split out from #887 ---
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is mostly a nicety for writing interactive documentation in #869
Most user interactions with
mlos_benchgo through json configs, so that's really what we want to document the most.I'd like to make those more easily browsable in the Sphinx generated docs, which means putting the json example configs into docstrings, but we want to ensure that those continue to load correctly by using
doctestRight now,
ConfigPersistenceServiceonly doesload_environmentvia a file, but it'd be pretty easy to extend it to support a json config string as well.The text was updated successfully, but these errors were encountered: