Skip to content

Commit ddfbc09

Browse files
authored
Add install instructions to README (#66)
* add install instructions to readme Signed-off-by: Maanu Grover <maanug@nvidia.com> * fix typo Signed-off-by: Maanu Grover <maanug@nvidia.com> * remove placeholder Signed-off-by: Maanu Grover <maanug@nvidia.com> --------- Signed-off-by: Maanu Grover <maanug@nvidia.com>
1 parent c1934e9 commit ddfbc09

1 file changed

Lines changed: 34 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,36 @@
11
# Megatron Hub: Training Recipes for Megatron-based LLM and VLM models
22

3-
More content coming soon ...
3+
## Installation
4+
5+
### Pip Installation
6+
To install with pip, use the following command:
7+
```
8+
pip install git+https://github.com/NVIDIA-NeMo/Megatron-Hub.git
9+
```
10+
11+
12+
### uv Installation
13+
To install Megatron-Hub to an active virtual environment or project environment, use the command:
14+
```
15+
uv pip install git+https://github.com/NVIDIA-NeMo/Megatron-Hub.git
16+
```
17+
18+
To add Megatron-Hub as a dependency for your project, use the following command:
19+
```
20+
uv add git+https://github.com/NVIDIA-NeMo/Megatron-Hub.git
21+
```
22+
23+
If you are a contributor, you can install this project for development with the following commands:
24+
```
25+
git clone https://github.com/NVIDIA-NeMo/Megatron-Hub.git
26+
cd Megatron-Hub
27+
uv sync
28+
```
29+
30+
To install additional dependency groups use one of the following commands instead:
31+
```
32+
uv sync --group docs # for building the documentation
33+
uv sync --group dev --group test # for running linters and tests
34+
```
35+
36+
If you do not have `uv` installed, please refer to the installation [docs](https://docs.astral.sh/uv/getting-started/installation/).

0 commit comments

Comments
 (0)