Skip to content

[docs] document eval events and callback references#3938

Open
vishruthb wants to merge 1 commit into
mosaicml:mainfrom
vishruthb:vish/eval-docs
Open

[docs] document eval events and callback references#3938
vishruthb wants to merge 1 commit into
mosaicml:mainfrom
vishruthb:vish/eval-docs

Conversation

@vishruthb

Copy link
Copy Markdown

What does this PR do?

Documents the standalone eval event flow for direct Trainer.eval() calls in the Event API docs.

This also fixes stale event references in event/callback documentation:

  • BEFORE_EVAL_ALL -> EVAL_BEFORE_ALL
  • AFTER_EVAL_ALL -> EVAL_AFTER_ALL
  • EVAL_BATCH_FORWARD -> EVAL_BEFORE_FORWARD
  • PREDICT_BATCH_FORWARD -> PREDICT_BEFORE_FORWARD

It also clarifies that EVAL_END fires once per evaluator/validation dataset.

What issue(s) does this change relate to?

Before submitting

  • Have you read the contributor guidelines?
  • Is this change a documentation change or typo fix? If so, skip the rest of this checklist.
  • Was this change discussed/approved in a GitHub issue first? It is much more likely to be merged if so.
  • Did you update any related docs and document your change?
  • Did you update any related tests and add any new tests related to your change? (see testing)
  • Did you run the tests locally to make sure they pass?
  • Did you run pre-commit on your change? (see the pre-commit section of prerequisites)

@vishruthb

Copy link
Copy Markdown
Author

hi @bowenyang008, wanted to quickly bump this when you have a chance. happy to make changes as you see fit!

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.

EVAL_STANDALONE_END documentation missing

1 participant