Skip to content

More documentation updates#887

Merged
bpkroth merged 23 commits into
microsoft:mainfrom
bpkroth:more-docs
Dec 5, 2024
Merged

More documentation updates#887
bpkroth merged 23 commits into
microsoft:mainfrom
bpkroth:more-docs

Conversation

@bpkroth

@bpkroth bpkroth commented Nov 22, 2024

Copy link
Copy Markdown
Contributor

Pull Request

Title

More documentation updates


Description

  • Adds general documentation on philosophy and usage
  • Additional docs about Config structure
  • Adjusts README documentation links
  • Additional documentation about Storage classes

Type of Change

  • 📝 Documentation update
  • 🧪 Tests

Additional Notes (optional)

Follow on to #869


@bpkroth bpkroth added the WIP Work in progress - do not merge yet label Nov 22, 2024
Comment thread Makefile
Comment thread doc/source/conf.py
Comment thread doc/source/index.rst
Comment thread doc/source/index.rst
Comment thread mlos_bench/README.md
@bpkroth bpkroth removed the WIP Work in progress - do not merge yet label Dec 5, 2024
@bpkroth bpkroth added documentation Improvements or additions to documentation ready for review Ready for review labels Dec 5, 2024
@bpkroth bpkroth marked this pull request as ready for review December 5, 2024 20:58
@bpkroth bpkroth requested a review from a team as a code owner December 5, 2024 20:58
@bpkroth bpkroth merged commit eb755b9 into microsoft:main Dec 5, 2024
@bpkroth bpkroth deleted the more-docs branch December 5, 2024 21:34
bpkroth added a commit that referenced this pull request 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

Labels

documentation Improvements or additions to documentation ready for review Ready for review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants