Use ci.py explicitly in docs building instructions#9971
Conversation
driazati
requested review from
a team,
areusch,
comaniac,
icemelon,
jroesch,
junrushao,
merrymercy,
tqchen and
yzhliu
as code owners
| function join_by { local IFS="$1"; shift; echo "$*"; } | ||
|
|
||
| IGNORED_WARNINGS=( | ||
| '__mro__' |
There was a problem hiding this comment.
could you add a comment explaining why these are ignored, and which piece of the warning string these match? i.e if I want to add one here, what do i do?
There was a problem hiding this comment.
Added a comment, generally people shouldn't be adding new warnings here unless there are infra problems (i.e. we had to ignore some stuff when bumping up the PyTorch version). Most of these aren't new and were being ignored before, just not in the actual docs build (where they weren't checked at all) and only on the precheck.
| 'autotvm:Cannot find config for target=cuda -keys=cuda,gpu' | ||
| ) | ||
|
|
||
| JOINED_WARNINGS=$(join_by '|' "${IGNORED_WARNINGS[@]}") |
There was a problem hiding this comment.
this is a little perilous as they aren't escaped. wdyt about doing this in python and then we could add tests?
There was a problem hiding this comment.
ideally the entire CI would be mostly Python and minimal bash instead of the opposite which we have right now. but to keep this PR simple since it does re-arrange a bunch of stuff I think we should leave it as is for now and leave migrating to Python for a follow up
This adds `ci.py` to the docs to make it more clear how to easily build the docs locally. This also re-arranges CI following the merging of all CI steps to run concurrently since there's no need to run the Sphinx precheck during GPU unit tests. This still preserves it though in the docs step as a way to quickly bail out if there are formatting errors so the full tutorials don't get built.
Mousius
left a comment
Mousius
left a comment
There was a problem hiding this comment.
Kicked off the branch check to make sure this runs smoothly but otherwise LGTM
|
Thanks @driazati 😸 |
This is empty following #9971 and is no longer needed Co-authored-by: driazati <driazati@users.noreply.github.com>
This adds `ci.py` to the docs to make it more clear how to easily build the docs locally. This also re-arranges CI following the merging of all CI steps to run concurrently since there's no need to run the Sphinx precheck during GPU unit tests. This still preserves it though in the docs step as a way to quickly bail out if there are formatting errors so the full tutorials don't get built. Co-authored-by: driazati <driazati@users.noreply.github.com>
This is empty following apache#9971 and is no longer needed Co-authored-by: driazati <driazati@users.noreply.github.com>
4 participants
This adds
ci.pyto the docs to make it more clear how to easily build the docs locally. This also re-arranges CI following the merging of all CI steps to run concurrently since there's no need to run the Sphinx precheck during GPU unit tests. This still preserves it though in the docs step as a way to quickly bail out if there are formatting errors so the full tutorials don't get built. Doing that surfaced a bunch of warnings in the full docs build that were previously just ignored (hence the extra warnings in the grep regex)Ignored warnings from: https://ci.tlcpack.ai/blue/organizations/jenkins/tvm/detail/PR-9971/1/pipeline/
cc @areusch