Skip to content

Add new directory for prototype tutorials #1058

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

Merged
merged 5 commits into from
Jul 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions .jenkins/build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,16 @@ if [[ "${JOB_BASE_NAME}" == *worker_* ]]; then
FILES_TO_RUN+=($(basename $filename .py))
fi
count=$((count+1))
done
for filename in $(find prototype_source/ -name '*.py' -not -path '*/data/*'); do
if [ $(($count % $NUM_WORKERS)) != $WORKER_ID ]; then
echo "Removing runnable code from "$filename
python $DIR/remove_runnable_code.py $filename $filename
else
echo "Keeping "$filename
FILES_TO_RUN+=($(basename $filename .py))
fi
count=$((count+1))
done
echo "FILES_TO_RUN: " ${FILES_TO_RUN[@]}

Expand All @@ -94,13 +104,13 @@ if [[ "${JOB_BASE_NAME}" == *worker_* ]]; then

# Step 4: If any of the generated files are not related the tutorial files we want to run,
# then we remove them
for filename in $(find docs/beginner docs/intermediate docs/advanced docs/recipes -name '*.html'); do
for filename in $(find docs/beginner docs/intermediate docs/advanced docs/recipes docs/prototype -name '*.html'); do
file_basename=$(basename $filename .html)
if [[ ! " ${FILES_TO_RUN[@]} " =~ " ${file_basename} " ]]; then
rm $filename
fi
done
for filename in $(find docs/beginner docs/intermediate docs/advanced docs/recipes -name '*.rst'); do
for filename in $(find docs/beginner docs/intermediate docs/advanced docs/recipes docs/prototype -name '*.rst'); do
file_basename=$(basename $filename .rst)
if [[ ! " ${FILES_TO_RUN[@]} " =~ " ${file_basename} " ]]; then
rm $filename
Expand All @@ -124,7 +134,7 @@ if [[ "${JOB_BASE_NAME}" == *worker_* ]]; then
rm $filename
fi
done
for filename in $(find docs/.doctrees/beginner docs/.doctrees/intermediate docs/.doctrees/advanced docs/.doctrees/recipes -name '*.doctree'); do
for filename in $(find docs/.doctrees/beginner docs/.doctrees/intermediate docs/.doctrees/advanced docs/.doctrees/recipes docs/.doctrees/prototype -name '*.doctree'); do
file_basename=$(basename $filename .doctree)
if [[ ! " ${FILES_TO_RUN[@]} " =~ " ${file_basename} " ]]; then
rm $filename
Expand Down
4 changes: 2 additions & 2 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@

sphinx_gallery_conf = {
'examples_dirs': ['beginner_source', 'intermediate_source',
'advanced_source', 'recipes_source'],
'gallery_dirs': ['beginner', 'intermediate', 'advanced', 'recipes'],
'advanced_source', 'recipes_source', 'prototype_source'],
'gallery_dirs': ['beginner', 'intermediate', 'advanced', 'recipes', 'prototype'],
'filename_pattern': 'tutorial.py',
'backreferences_dir': False
}
Expand Down
7 changes: 7 additions & 0 deletions prototype_source/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Prototype Tutorials

This directory contains tutorials demonstrating prototype features in PyTorch.

**Prototype features** are not available as part of binary distributions like PyPI or Conda (except maybe behind run-time flags). To test these features we would, depending on the feature, recommend building from master or using the nightly wheelss that are made available on pytorch.org.

*Level of commitment:* We are committing to gathering high bandwidth feedback only on these features. Based on this feedback and potential further engagement between community members, we as a community will decide if we want to upgrade the level of commitment or to fail fast.
2 changes: 2 additions & 0 deletions prototype_source/README.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Prototype Tutorials
------------------