[Tune] Some examples pages are not structured well

[ArturNiederfahrenhorst]

Description

Some of our Tune examples look a little weird (example). There is an index at the top with only one entry “Example”.

Also, we dump some output that includes personal folder structure:

Amongst them, this HF page does not render the HF emoji/logo thingy in its title and has two files that are concatenated inside of it but that are not structured to make clear that the second one is ray.tune.examples.pbt_transformers.utils and imported in the first one.

Link

No response

[SamantaTarun]

I'd like to look on this.

[rajveer43]

I would like to work upon this

[justinvyu]

Thanks for offering to help!

Perhaps @tarunsamanta2k20 can fix up the huggingface example (fix the formatting, and make sure the 2nd file is properly labeled as the imported ray.tune.examples.pbt_transformers.utils, and @rajveer43 you can fix the formatting of the other Tune examples?

[rajveer43]

Sure @justinvyu , I would love to work on that! Would you tell me where exactly I need to work on?

[rajveer43]

Hey @justinvyu and @hora-anyscale, Would you tell me where Exactly I need to work. It would be really helpful

[ArturNiederfahrenhorst]

Hi @rajveer43 , hi @tarunsamanta2k20 ! Thanks for offering your help!

So, I think what you need to work on this is https://docs.ray.io/en/latest/ray-contribute/development.html#building-the-docs (to build the docs and see the effects of your changes). The file that you'd need to change is ray/doc/source/tune/examples/pbt_transformers.ipynb. Asfaics, you'd need to gain an understanding of what the example at hand illustrates and then give the file simple structure that looks tidy and write give a short description about what the user is looking at and how the code snippets in there relate to each other.

[rajveer43]

Sure. Can You Help me setting Up they Ray Repo. I have forked and created Venv. Do I Need to Build the Ray and then start working?

[ArturNiederfahrenhorst]

@rajveer43 Thanks! In order to properly develop on Ray (excluding Ray Core parts), please follow the instructions at https://docs.ray.io/en/latest/ray-contribute/development.html#building-ray-python-only

You should fork the repo and checkout master. If you are not on an M1 Mac, you can just install the Ray nightlies in your venv and the link the files to the files in your local clone of your fork with setup-dev, as described in the guide above.

[ArturNiederfahrenhorst]

From there, you can start iterating on your problem by making changes and building the docs to see the effects.

[ArturNiederfahrenhorst]

Please interact with @justinvyu if you have any more questions in the coming days, as I will be on vacation.

[rajveer43]

@justinvyu Can you help setting up ray things I did not working.