Skip to content

docs: Python SDK README update - #394

Merged
esthersweon merged 5 commits into
mainfrom
esw/python-readme
Oct 29, 2026
Merged

esthersweon merged 5 commits into
mainfrom
esw/python-readme

Conversation

@esthersweon

@esthersweon esthersweon commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

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

@esthersweon esthersweon changed the title docs: TypeScript SDK README update docs: Python SDK README update Oct 22, 2026
@esthersweon
esthersweon marked this pull request as ready for review October 27, 2026 17:45
@esthersweon
esthersweon requested a review from a team as a code owner October 27, 2026 17:45
@czi-fsisenda
czi-fsisenda requested a balanced review from Copilot October 27, 2026 21:53

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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

Comment thread sdks/python/README.md Outdated
evaluator = GradeLevelAppropriatenessEvaluator(google_api_key="...")

# Keywords
await evaluator.evaluate(text="The cat's out of the bag now.")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 czi-fsisenda left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just the comment about example code with sync and async.

@michael-berger-czi

Copy link
Copy Markdown
Contributor

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/.

Comment thread sdks/python/README.md Outdated
Comment thread sdks/python/README.md Outdated
@esthersweon
esthersweon merged commit f03eec9 into main Oct 29, 2026
22 checks passed
@esthersweon
esthersweon deleted the esw/python-readme branch October 29, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants