Adding getting started, and QAExample reward metadata match ds#4
Merged
jamesbraza merged 3 commits intomainfrom Jun 5, 2025
Merged
Adding getting started, and QAExample reward metadata match ds#4jamesbraza merged 3 commits intomainfrom
QAExample reward metadata match ds#4jamesbraza merged 3 commits intomainfrom
Conversation
jamesbraza
requested review from
albertbou92,
maykcaldas,
sidnarayanan and
whitead
There was a problem hiding this comment.
Pull Request Overview
This PR aligns the QAExample model and its tests by renaming the reward metadata field, and enriches the README with a “Getting Started” section for installation, reward functions, and visualization.
- Renames
QAExample.infotosolutionin the data model and updates tests - Adds a Usage section in README with installation steps, reward function examples, and visualization demo
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tests/test_models.py | Updated assertions and variable names to use solution instead of info |
| src/ether0/models.py | Renamed info field on QAExample to solution |
| README.md | Added Getting Started / Usage instructions and updated image alt text |
Comments suppressed due to low confidence (3)
tests/test_models.py:23
- [nitpick] Variable name
ex0_solis inconsistent with the existingex_0naming style; consider renaming toex_0_solutionfor clarity and consistency.
ex0_sol = ex_0.solution
tests/test_models.py:25
- Relying on the ordering of
model_dump().values()can make this test flaky; unpack and compare individual fields or compare the full dict to ensure deterministic behavior.
(ex0_sol.fxn_name, ex0_sol.answer_info, ex0_sol.problem_type) == tuple(ex0_sol.model_dump().values())
README.md:87
- [nitpick] The
uv synccommand may be unfamiliar to users; consider adding a brief note or link explaining whatuvis and how to install or configure it.
uv sync
whitead
approved these changes
Jun 5, 2025
Comment on lines
+95
to
+98
| from ether0.rewards import valid_mol_eval | ||
|
|
||
| # Task: provide a valid completion of this molecule | ||
| partial_smiles = "O=C(OC1C(OC(=O)C=2C=CC=CC2)C3(O)C(C)(C)CCCC3(C)C4CC=5OC=CC5C(C)C14" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR:
QAExample's reward metadata field to just matchether0-benchmark, to avoid confusion