Repository navigation
docs: Python SDK README update - #394
Conversation
04ffac6 to
6a2a5ea
Compare
There was a problem hiding this comment.
🟡 Changes recommended
The Python evaluation example mixes asynchronous and synchronous calls and cannot run as written.
1 open issue
What changed in this PR
Updates the Python SDK README to align with the TypeScript README’s structure and provide a more concise API guide.
Changes:
- Adds a supported-evaluator table with schema and documentation links.
- Reorganizes Python usage into quickstart, discovery, evaluation, outcomes, standards, and text-feature sections.
- Updates the schema-link wording in the TypeScript README.
| File | Description |
|---|---|
| sdks/typescript/README.md | Clarifies the input/output schema link label. |
| sdks/python/README.md | Reorganizes the SDK guide and refreshes examples and reference links. |
Review effort: Balanced
| evaluator = GradeLevelAppropriatenessEvaluator(google_api_key="...") | ||
|
|
||
| # Keywords | ||
| await evaluator.evaluate(text="The cat's out of the bag now.") |
There was a problem hiding this comment.
We could have
import asyncio
from learning_commons_evaluators import GradeLevelAppropriatenessEvaluator
evaluator = GradeLevelAppropriatenessEvaluator(google_api_key="...")
# Sync
evaluation = evaluator.evaluate_sync(text="The cat's out of the bag now.")
print(evaluation.result.grade_band)
# Async
async def main() -> None:
evaluation = await evaluator.evaluate(text="The cat's out of the bag now.")
print(evaluation.result.grade_band)
if __name__ == "__main__":
asyncio.run(main())
czi-fsisenda
left a comment
There was a problem hiding this comment.
LGTM! Just the comment about example code with sync and async.
|
One pre-existing issue worth fixing while this page is open (not introduced by this PR): sdks/typescript/README.md line 26 — the "Academic Standards evaluators" family link points to ../../evals/durable-skills/, but the row is Academic Standards. The schema links on the same line correctly point into ../../evals/academic-standards-alignment/, and the Python README's equivalent row links the right folder. The link resolves (the durable-skills folder exists), so it reads fine but lands readers in the wrong family. Suggested fix: change the family link target on line 26 to ../../evals/academic-standards-alignment/. |

Modified Python SDK README to reflect the recent updates made to the TypeScript SDK README