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

jax-toolbox-triage: improve documentation #1104

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

olupton
Copy link
Contributor

@olupton olupton commented Oct 16, 2024

Improve documentation of the triage tool added in #793.

Copy link
Collaborator

@nouiz nouiz left a comment

Choose a reason for hiding this comment

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

Looks pretty good!

specific commit of JAX or XLA.
__Note__: There is also a [triage tool](triage-tool.md), which can be used for
more granular bisection of failures in specific tests. Given a test expression that can
be run inside the nightl containers (*e.g.* `test-jax.sh jet_test_gpu`), it first
Copy link
Collaborator

Choose a reason for hiding this comment

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

nightl -> nightly

Suggested change
be run inside the nightl containers (*e.g.* `test-jax.sh jet_test_gpu`), it first
be run inside the nightly containers (*e.g.* `test-jax.sh jet_test_gpu`), it first

__Note__: There is also a [triage tool](triage-tool.md), which can be used for
more granular bisection of failures in specific tests. Given a test expression that can
be run inside the nightl containers (*e.g.* `test-jax.sh jet_test_gpu`), it first
identifies the nightl container where the failure first appeared, and second attributes
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
identifies the nightl container where the failure first appeared, and second attributes
identifies the nightly container where the failure first appeared, and second attributes


`jax-toolbox-triage` is a tool to automate the process of attributing regressions to an
individual commit of JAX or XLA.
It takes as input a command that returns an error (non-zero) code when run in "recent"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Specify if the scripts are expected to be in the container already or not.
Maybe specify somewhere what will happens if JAX or XLA compilation fail? Does the script just skip that commit test with git bisect skip?

but that if JAX is moved forward to include
[jax@b164d](https://github.com/jax-ml/jax/commit/b164d67d4a9bd094426ff450fe1f1335d3071d03)
then the test fails.
This failure is fixed in XXX.
Copy link
Contributor

Choose a reason for hiding this comment

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

What is this?

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.

3 participants