numpy-tutorials icon indicating copy to clipboard operation
numpy-tutorials copied to clipboard

MAINT: move non-executable content to its own category.

Open rossbar opened this issue 2 years ago • 3 comments

As discussed in the previous documentation meeting, this PR implements the "medium-term" solution to the tutorials that have been added but are not currently executable.

Essentially, this moves the RL and NLP tutorials to a separate category that I called "articles" (naming suggestions welcome) and adds some text that these are not tested. I've also added admonitions soliciting contributions from any one who might be interested in helping to make them fully executable.

rossbar avatar Sep 08 '22 21:09 rossbar

Essentially, this moves the RL and NLP tutorials to a separate category that I called "articles" (naming suggestions welcome) and adds some text that these are not tested. I've also added admonitions soliciting contributions from any one who might be interested in helping to make them fully executable.

What are the limitations on making them executable? Too many dependencies/resource requirements for being practical, or some other reasons?

bsipocz avatar Sep 21 '22 19:09 bsipocz

What are the limitations on making them executable? Too many dependencies/resource requirements for being practical, or some other reasons?

For the reinforcement learning tutorial, it's a dependency issue - specifically licensing of ROMs which have EULA's/potential licensing concerns. See e.g. #87 for more details.

For the NLP tutorial it was mostly a matter of data hosting which was the bottleneck, then the tutorial was merged provisionally with the intention of following up once a tutorial data hosting solution had been worked out. Since it wasn't executable when merged, this one would also need review.

rossbar avatar Oct 04 '22 21:10 rossbar

Oh, wonderful.

bsipocz avatar Oct 04 '22 21:10 bsipocz

@melissawm just a quick ping here if you have any thoughts on this reorganization proposal!

rossbar avatar Oct 31 '22 23:10 rossbar

Thanks all - I'll go ahead and get this in. Once the categories are separated, if anyone would like to add/adjust the admonitions, please follow-up with an issue/PR!

rossbar avatar Jan 16 '23 06:01 rossbar