Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Fix docs formatting#188

Merged
amogkam merged 120 commits intoray-project:mainfrom
JiahaoYao:fix_ray_doc
Aug 1, 2022
Merged

Fix docs formatting#188
amogkam merged 120 commits intoray-project:mainfrom
JiahaoYao:fix_ray_doc

Conversation

@JiahaoYao
Copy link
Copy Markdown
Contributor

this pr fixes the ray build doc issue

reading sources... [100%] ray-more-libs/xgboost-ray
/Users/rliaw/miniconda3/envs/doc/lib/python3.7/site-packages/ray_lightning/ray_ddp.py:docstring of ray_lightning.ray_ddp.RayStrategy:19: WARNING: Unexpected indentation.
/Users/rliaw/miniconda3/envs/doc/lib/python3.7/site-packages/ray_lightning/ray_ddp.py:docstring of ray_lightning.ray_ddp.RayStrategy:21: WARNING: Block quote ends without a blank line; unexpected unindent.
/Users/rliaw/miniconda3/envs/doc/lib/python3.7/site-packages/ray_lightning/ray_ddp.py:docstring of ray_lightning.ray_ddp.RayStrategy:35: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 38 supplied.

.. code-block:: python
    import pytorch_lightning as ptl
    from ray_lightning import RayAccelerator
    ptl_model = MNISTClassifier(...)
    strategy = RayStrategy(num_workers=4, cpus_per_worker=1,
        use_gpu=True)
    # Don't set ``gpus`` in ``Trainer``.
    # The actual number of GPUs is determined by ``num_workers``.
    trainer = pl.Trainer(..., strategy=strategy)
    trainer.fit(ptl_model)
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] ray-more-libs/xgboost-ray
/Users/rliaw/ray/doc/source/ray-more-libs/ray-lightning.md:185: WARNING: 'myst' reference target not found: ./docs/horovod_faq.md
generating indices... genindex py-modindex done
lz4 not available, disabling sample compression. This will significantly impact RLlib perf

this is fixed through this pr.

Copy link
Copy Markdown
Collaborator

@amogkam amogkam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @JiahaoYao

@amogkam amogkam changed the title fix the ray build doc issue Fix docs formatting Jul 30, 2022
@JiahaoYao
Copy link
Copy Markdown
Contributor Author

JiahaoYao commented Jul 30, 2022

thank you @amogkam !

@amogkam amogkam merged commit 10a0854 into ray-project:main Aug 1, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants