Skip to content

Commit d24be5e

Browse files
committedAug 12, 2024
mention MNIST to examples/README.md
1 parent 9819226 commit d24be5e

File tree

1 file changed

+20
-14
lines changed

1 file changed

+20
-14
lines changed
 

‎examples/README.md

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,37 +19,43 @@ be found at the beginning of each file.
1919
---
2020
### Overview of Test Programs
2121

22+
* [MNIST](./MNIST)
23+
+ This directory contains an example of
24+
[MNIST](https://github.com/pytorch/examples/tree/main/mnist),
25+
using Pytorch module `DistributedDataParallel` for parallel training and
26+
`PnetCDF-Python` for reading data from a NetCDF files.
27+
2228
* [Pytorch_DDP](./Pytorch_DDP)
23-
+ A directory containing examples that make use of Pytorch Distributed Data
29+
+ A directory contains examples that make use of Pytorch Distributed Data
2430
Parallel module to run python programs in parallel.
2531

2632
* [collective_write.py](./collective_write.py)
27-
+ writes multiple 3D subarrays to non-record variables of int type using
28-
collective I/O mode.
33+
+ This example writes multiple 3D subarrays to non-record variables of int
34+
type using collective I/O mode.
2935

3036
* [put_vara.py](./put_vara.py)
3137
+ This example shows how to use `Variable` method put_var() to write a 2D
3238
integer array in parallel. The data partitioning pattern is a column-wise
3339
partitioning across all processes.
3440

3541
* [get_vara.py](./get_vara.py)
36-
+ This is the read counterpart of [put_vara.py](./put_vara.py), which shows
37-
how to use to `Variable` method get_var() read a 2D 4-byte integer array in
38-
parallel.
42+
+ This example is the read counterpart of [put_vara.py](./put_vara.py), which
43+
shows how to use to `Variable` method get_var() read a 2D 4-byte integer
44+
array in parallel.
3945

4046
* [nonblocking_write.py](./nonblocking_write.py)
41-
+ Similar to `collective_write.py`, it uses nonblocking APIs instead. It
42-
creates a netcdf file in CDF-5 format and writes a number of 3D integer
43-
non-record variables.
47+
+ Similar to `collective_write.py`, this example uses nonblocking APIs
48+
instead. It creates a netcdf file in CDF-5 format and writes a number of 3D
49+
integer non-record variables.
4450

4551
* [nonblocking_write_def.py](./nonblocking_write_def.py)
46-
+ This is the same as `nonblocking_write.py` expect all nonblocking write
47-
requests (calls to `iput` and `bput`) are posted in define mode. It creates
48-
a netcdf file in CDF-5 format and writes a number of 3D integer non-record
49-
variables.
52+
+ This example is the same as `nonblocking_write.py` expect all nonblocking
53+
write requests (calls to `iput` and `bput`) are posted in define mode. It
54+
creates a netcdf file in CDF-5 format and writes a number of 3D integer
55+
non-record variables.
5056

5157
* [create_open.py](./create_open.py)
52-
+ This example shows how to use `File` class constructor to create a netCDF
58+
+ This example shows how to use `File` class constructor to create a NetCDF
5359
file and to open the file for read only.
5460

5561
* [ghost_cell.py](./ghost_cell.py)

0 commit comments

Comments
 (0)