Skip to content

Commit 7e4e156

Browse files
committed
Address code review.
1 parent 8f52204 commit 7e4e156

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

docs/triage-tool.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
individual commit of JAX or XLA.
55
It takes as input a command that returns an error (non-zero) code when run in "recent"
66
containers, but which returns a success (zero) code when run in some "older" container.
7+
The command must be executable within the containers, *i.e.* it cannot refer to files
8+
that only exist on the host system.
79

810
The tool follows a three-step process:
911
1. A container-level search backwards from the "recent" container where the test is
@@ -220,7 +222,7 @@ and
220222
but that if JAX is moved forward to include
221223
[jax@b164d](https://github.com/jax-ml/jax/commit/b164d67d4a9bd094426ff450fe1f1335d3071d03)
222224
then the test fails.
223-
This failure is fixed in XXX.
225+
This failure is fixed in [jax#24427](https://github.com/jax-ml/jax/pull/24427).
224226

225227
## Limitations
226228

@@ -239,6 +241,9 @@ Other limitations include that only `docker` is supported as a container runtime
239241
also implies that it is not currently possible to triage a test that requires a
240242
multi-node or multi-process test.
241243

244+
The tool also does not currently handle skipping commits that do not compile, or test
245+
cases that require copying files (*e.g.* script files) into the container.
246+
242247
If you run into these limitations in real-world usage of this tool, please file a bug
243248
against JAX-Toolbox including details of manual steps you took to root-case the test
244249
regression.

docs/triage.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ but this automates the investigation of questions like "what state of library X
66

77
__Note__: There is also a [triage tool](triage-tool.md), which can be used for
88
more granular bisection of failures in specific tests. Given a test expression that can
9-
be run inside the nightl containers (*e.g.* `test-jax.sh jet_test_gpu`), it first
10-
identifies the nightl container where the failure first appeared, and second attributes
9+
be run inside the nightly containers (*e.g.* `test-jax.sh jet_test_gpu`), it first
10+
identifies the nightly container where the failure first appeared, and second attributes
1111
the failure to a specific commit of JAX or XLA.
1212

1313
## Algorithm

0 commit comments

Comments
 (0)