Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(weave): Refactor Evals and Scoring section #3066

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open

Conversation

J2-D2-3PO
Copy link
Contributor

@J2-D2-3PO J2-D2-3PO commented Nov 23, 2024

Description

https://wandb.atlassian.net/browse/DOCS-1062

Refactor of https://weave-docs.wandb.ai/guides/core-types/evaluations and https://weave-docs.wandb.ai/guides/evaluation/scorers

image

Other changes

  • Modifies non-docs files to correct links with parent folder name change
    modified: weave-js/src/components/PagePanelComponents/Home/Browse3/pages/ScorersPage/ScorerForms.tsx modified: weave-js/src/components/PagePanelComponents/Home/Browse3/pages/common/EmptyContent.tsx
  • Also fixes random broken anchors in unrelated pages that surfaced from local yarn docusaurus build:
Exhaustive list of all broken anchors found:
- Broken anchor on source page path = /guides/tracking/tracing:
   -> linking to /reference/python-sdk/weave/#function-attributes
- Broken anchor on source page path = /reference/python-sdk/weave/:
   -> linking to #function-attributes (resolved as: /reference/python-sdk/weave/#function-attributes)

@J2-D2-3PO J2-D2-3PO self-assigned this Nov 23, 2024
@J2-D2-3PO J2-D2-3PO changed the title Refactor Evals and Scoring section docs(weave): Refactor Evals and Scoring section Nov 23, 2024
@J2-D2-3PO J2-D2-3PO changed the title docs(weave): Refactor Evals and Scoring section docs(weave): [WIP] Refactor Evals and Scoring section Nov 23, 2024
@circle-job-mirror
Copy link

circle-job-mirror bot commented Nov 23, 2024

@J2-D2-3PO J2-D2-3PO marked this pull request as ready for review December 6, 2024 01:59
@J2-D2-3PO J2-D2-3PO requested a review from a team as a code owner December 6, 2024 01:59
@J2-D2-3PO J2-D2-3PO marked this pull request as draft December 6, 2024 02:03
@J2-D2-3PO J2-D2-3PO marked this pull request as ready for review December 6, 2024 16:36
@J2-D2-3PO J2-D2-3PO changed the title docs(weave): [WIP] Refactor Evals and Scoring section docs(weave): Refactor Evals and Scoring section Dec 6, 2024
@J2-D2-3PO J2-D2-3PO removed the request for review from johndmulhausen December 13, 2024 19:37
@J2-D2-3PO J2-D2-3PO requested a review from a team as a code owner January 12, 2025 23:27
@J2-D2-3PO J2-D2-3PO marked this pull request as draft January 12, 2025 23:27
@J2-D2-3PO
Copy link
Contributor Author

J2-D2-3PO commented Jan 13, 2025

@tssweeney, what if we merge your #3344 into this PR and ship everything at once (assuming timing works out)? I'd have to make a few mods to fithttps://github.com/wandb/weave/blob/49b32c00a15ab7989f99af43e11a8dead26a5c6c/docs/docs/guides/evaluation/guardrails_and_monitors.md in to the new structure, but it seems like it would fit logically in the new structure. LMK what you think

...
LLM Application Tracing
Scorers
    Evaluations
    Guardrails <- guardrails_and_monitors.md
    Built-in Scorers
    Custom scorers
    Working With Scorers
Prompts
...

@J2-D2-3PO J2-D2-3PO marked this pull request as ready for review January 13, 2025 02:28
@J2-D2-3PO J2-D2-3PO requested a review from a team as a code owner January 13, 2025 02:28
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.

1 participant