mirror of https://github.com/hpcaitech/ColossalAI
fixed utils docstring and add example to readme (#200)
parent
b9a761b9b8
commit
812357d63c
10
README.md
10
README.md
|
@ -3,7 +3,11 @@
|
||||||
[![logo](./docs/images/Colossal-AI_logo.png)](https://www.colossalai.org/)
|
[![logo](./docs/images/Colossal-AI_logo.png)](https://www.colossalai.org/)
|
||||||
|
|
||||||
<div align="center">
|
<div align="center">
|
||||||
<h3> <a href="https://arxiv.org/abs/2110.14883"> Paper </a> | <a href="https://www.colossalai.org/"> Documentation </a> | <a href="https://github.com/hpcaitech/ColossalAI/discussions"> Forum </a> | <a href="https://medium.com/@hpcaitech"> Blog </a></h3>
|
<h3> <a href="https://arxiv.org/abs/2110.14883"> Paper </a> |
|
||||||
|
<a href="https://www.colossalai.org/"> Documentation </a> |
|
||||||
|
<a href="https://github.com/hpcaitech/ColossalAI-Examples"> Examples </a> |
|
||||||
|
<a href="https://github.com/hpcaitech/ColossalAI/discussions"> Forum </a> |
|
||||||
|
<a href="https://medium.com/@hpcaitech"> Blog </a></h3>
|
||||||
|
|
||||||
[![Build](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml/badge.svg)](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml)
|
[![Build](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml/badge.svg)](https://github.com/hpcaitech/ColossalAI/actions/workflows/PR_CI.yml)
|
||||||
[![Documentation](https://readthedocs.org/projects/colossalai/badge/?version=latest)](https://colossalai.readthedocs.io/en/latest/?badge=latest)
|
[![Documentation](https://readthedocs.org/projects/colossalai/badge/?version=latest)](https://colossalai.readthedocs.io/en/latest/?badge=latest)
|
||||||
|
@ -38,10 +42,6 @@ pip install -v --no-cache-dir --global-option="--cuda_ext" .
|
||||||
pip install colossalai
|
pip install colossalai
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
|
||||||
|
|
||||||
- [Documentation](https://www.colossalai.org/)
|
|
||||||
|
|
||||||
|
|
||||||
## Use Docker
|
## Use Docker
|
||||||
|
|
||||||
|
|
|
@ -123,7 +123,7 @@ def get_dataloader(dataset,
|
||||||
.. note:: When pipeline parallel is enabled, shuffle cannot be True as it will result in mismatch between input data
|
.. note:: When pipeline parallel is enabled, shuffle cannot be True as it will result in mismatch between input data
|
||||||
on the 1st stage and label on the last stage
|
on the 1st stage and label on the last stage
|
||||||
|
|
||||||
:param dataset: A :class:`utils.data.dataset dataset`
|
:param dataset: A :class:`torch.utils.data.Dataset` object
|
||||||
:param shuffle: Whether to shuffle the dataset
|
:param shuffle: Whether to shuffle the dataset
|
||||||
:param seed: Random worker seed, defaults to 1024
|
:param seed: Random worker seed, defaults to 1024
|
||||||
:param add_sampler: Add DistributedDataParallelSampelr to the dataset
|
:param add_sampler: Add DistributedDataParallelSampelr to the dataset
|
||||||
|
|
Loading…
Reference in New Issue