Skip to content

Commit 0fa0241

Browse files
committed
Add troubleshooting
1 parent b773493 commit 0fa0241

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

USAGE.md

+11-4
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
- [Deployment Launcher](#deployment-launcher)
2323
- [Model Deployment](#model-deployment)
2424
- [Docker Environment](#docker-environment)
25+
- [Troubleshooting](#troubleshooting)
2526

2627
## 3D Parallelism
2728

@@ -683,9 +684,9 @@ Note that you don't need to use distributed launcher when you use deployment lau
683684

684685
### Model Deployment
685686

686-
The usage of deployment launcher is similar with 3D parallelization.
687+
The usage of deployment launcher is similar with 3D parallelism.
687688
Just input the argument `deployment=True`.
688-
Similar with 3D parallelism, the model can be created from split or merged checkpoints, and features such as kernel fusion can be used together.
689+
The model can be created from split or merged checkpoints, and features such as kernel fusion can also be used together.
689690

690691
```python
691692
from oslo import GPTNeoForCausalLM
@@ -756,5 +757,11 @@ But when deploying using pipeline parallelism, you don't have to write a new loo
756757
So, please write your code as usual.
757758

758759
### Docker Environment
759-
Deployment Launcher uses shared memory to share data between processes. However, Docker is designed to use limited shared memory by default. Therefore, when using the Deployment Launcher in a Docker container environment, the shared memory size must be increased, and the larger the model, the larger the shared memory is required.
760-
You can set the larger shared memory size using `--shm-size=?gb`, and you can also disable shared memory limit by using `--ipc=host`.
760+
Deployment Launcher uses shared memory to share data between processes. However, Docker is designed to use limited shared memory by default. Therefore, when using the Deployment Launcher in a Docker container, the shared memory size must be increased, and the larger the model, the larger the shared memory is required.
761+
You can set the larger shared memory size using `--shm-size=?gb`, and you can also disable shared memory limit by using `--ipc=host`.
762+
763+
## Troubleshooting
764+
If you have any questions, bug reports, and feature requests, please open an issue on github or
765+
contacts [[email protected]](mailto:[email protected]) please.
766+
767+
We appreciate any kind of feedback or contribution. Feel free to proceed with small issues like bug fixes, documentation improvement. For major contributions and new features, please discuss with the collaborators in corresponding issues.

0 commit comments

Comments
 (0)