Skip to content

Commit 0701fc1

Browse files
authored
Update README.md
1 parent 9acbeec commit 0701fc1

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,15 @@
33
<img alt="C++20" src="https://img.shields.io/badge/C%2B%2B-20-blue?style=plastic&logo=cplusplus&logoColor=blue"> <img alt="CUDA-12" src="https://img.shields.io/badge/CUDA-12-green?style=plastic&logo=nvidia"> <img alt="Static Badge" src="https://img.shields.io/badge/python-3-blue?style=plastic&logo=python&logoColor=blue"> <img alt="Static Badge" src="https://img.shields.io/badge/pytorch-2-orange?style=plastic&logo=pytorch">
44
</div>
55

6-
## Environment
6+
## 1. Environment
77

8-
The simplest way is to use my docker image {{<href text="jamesnulliu/deeplearning:latest" url="https://hub.docker.com/r/jamesnulliu/deeplearning">}} which contains all the softwares you need to build the project:
8+
The simplest way is to use my docker image [jamesnulliu/deeplearning:latest](https://hub.docker.com/r/jamesnulliu/deeplearning) which contains all the softwares you need to build the project:
99

1010
```bash
1111
docker pull jamesnulliu/deeplearning:latest
1212
```
1313

14-
> 📝**NOTE**
15-
> Check my blog: [Docker Container with Nvidia GPU Support](/blogs/docker-container-with-nvidia-gpu-support) if you need any help.
14+
> Check my blog: [Docker Container with Nvidia GPU Support](https://jamesnulliu.github.io/blogs/docker-container-with-nvidia-gpu-support) if you need any help.
1615
1716
Or if you are planing to build your own environment, here are some tips:
1817

@@ -24,19 +23,21 @@ You should install all the softwares with corresponding versions listed bellow:
2423
- Ninja
2524
- vcpkg, pkg-config
2625
- [managed by conda] python >= 3.10, pytorch >= 2.0
27-
- [managed by vcpkg] cxxopts, fmt, spdlog, proxy, gtest, yamel-cpp
26+
- [managed by vcpkg] cxxopts, fmt, spdlog, proxy, gtest, yaml-cpp
2827

2928
**🎯Miniconda**
3029

31-
Managing python environment with miniconda is always a good choice. Check [the official website](https://docs.anaconda.com/miniconda/install/#quick-command-line-install) for an installation guide.
30+
Managing python environments with miniconda is always a good choice. Check [the official website](https://docs.anaconda.com/miniconda/install/#quick-command-line-install) for an installation guide.
3231

3332
After installation, if you do not intend to install all the packages in `base` environment, create a new conda environment named `PMPP` (or whatever you like) and activate it:
3433

3534
```bash {linenos=true}
3635
# python version should be larger than 3.10
3736
conda create -n PMPP python=3.12
3837
conda activate PMPP # Activate this environment
39-
# In my experience, when your system gcc version is larger than 12, it is highly possible that you have to update libstd++ in conda for running the later compiled targets. All you need to do is to run this command:
38+
# In my experience, when your system gcc version is larger than 12, it is
39+
# highly possible that you have to update libstd++ in conda for running the
40+
# later compiled targets. All you need to do is to run this command:
4041
conda upgrade libstdcxx-ng -c conda-forge
4142
```
4243

@@ -56,7 +57,7 @@ You can find all versions of cuda on [the official website](https://developer.nv
5657
> 📝**NOTE**
5758
> Installing and using multiple versions of cuda is possible by managing the `PATH` and `LD_LIBRARY_PATH` environment variables on linux, and you can do this manually or refering to my methods in [this blog](/blogs/environment-variable-management).
5859
59-
## Quick Start
60+
## 2. Quick Start
6061

6162
To build the C++ part only:
6263

@@ -83,7 +84,7 @@ GTEST_COLOR=yes cmake --build $BUILD_DIR -j $(nproc) --target all check
8384
GTEST_COLOR=yes cmake --build $BUILD_DIR -j $(nproc) --target check
8485
```
8586

86-
To build and install the python package `pmpp` in current activated conda environment (pmpp operator library would be built automatically if has not been built):
87+
To build and install the python package `pmpp` in current activated conda environment (pmpp operator library would be built automatically if it has not been built yet):
8788

8889
```bash
8990
pip3 install --no-build-isolation -v .

0 commit comments

Comments
 (0)