mirror of
https://github.com/saymrwulf/pytorch.git
synced 2026-05-14 20:57:59 +00:00
4618371da5
This is a new version of #15648 based on the latest master branch. Unlike the previous PR where I fixed a lot of the doctests in addition to integrating xdoctest, I'm going to reduce the scope here. I'm simply going to integrate xdoctest, and then I'm going to mark all of the failing tests as "SKIP". This will let xdoctest run on the dashboards, provide some value, and still let the dashboards pass. I'll leave fixing the doctests themselves to another PR. In my initial commit, I do the bare minimum to get something running with failing dashboards. The few tests that I marked as skip are causing segfaults. Running xdoctest results in 293 failed, 201 passed tests. The next commits will be to disable those tests. (unfortunately I don't have a tool that will insert the `#xdoctest: +SKIP` directive over every failing test, so I'm going to do this mostly manually.) Fixes https://github.com/pytorch/pytorch/issues/71105 @ezyang Pull Request resolved: https://github.com/pytorch/pytorch/pull/82797 Approved by: https://github.com/ezyang
29 lines
1.1 KiB
Bash
Executable file
29 lines
1.1 KiB
Bash
Executable file
#!/bin/bash
|
|
__doc__="
|
|
This script simply runs the torch doctests via the xdoctest runner.
|
|
|
|
This must be run from the root of the torch repo, as it needs the path to the
|
|
torch source code.
|
|
"
|
|
|
|
#xdoctest -m torch --style=google list
|
|
|
|
# Reference: https://stackoverflow.com/questions/59895/bash-script-dir
|
|
SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
|
|
TORCH_MODPATH=$SCRIPT_DIR/../torch
|
|
echo "TORCH_MODPATH = $TORCH_MODPATH"
|
|
|
|
if [[ ! -d "$TORCH_MODPATH" ]] ; then
|
|
echo "Could not find the path to the torch module"
|
|
else
|
|
|
|
# Next version of xdoctest will support environment variables that overlo
|
|
|
|
|
|
export XDOCTEST_GLOBAL_EXEC="from torch import nn\nimport torch.nn.functional as F\nimport torch"
|
|
export XDOCTEST_OPTIONS="+IGNORE_WHITESPACE"
|
|
# Note: google wont catch numpy style docstrings (a few exist) but it also wont fail
|
|
# on things not intended to be doctests.
|
|
export XDOCTEST_STYLE="google"
|
|
xdoctest "$TORCH_MODPATH" --style="$XDOCTEST_STYLE" --global-exec "$XDOCTEST_GLOBAL_EXEC" --options="$XDOCTEST_OPTIONS"
|
|
fi
|