Skip to content

Commit b22cb0a

Browse files
authored
README (#277)
1 parent d9cc618 commit b22cb0a

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

README.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
# NeMo-Run
1+
# NeMo Run
22

33
> [!IMPORTANT]
4-
> NeMo-Run is still in active development and this is a pre-release. The API is subject to change without notice while in pre-release. First official release will be 0.1.0 and will be included in NeMo FW 24.09 as well.
4+
> NeMo Run is still in active development and this is a pre-release. The API is subject to change without notice while in pre-release. First official release will be 0.1.0 and will be included in NeMo FW 24.09 as well.
55
6-
NeMo-Run is a powerful tool designed to streamline the configuration, execution, and management of machine learning experiments across various computing environments. NeMo-Run has three core responsibilities:
6+
NeMo Run is a powerful tool designed to streamline the configuration, execution, and management of machine learning experiments across various computing environments. NeMo Run has three core responsibilities:
77

88
1. [Configuration](./docs/source/guides/configuration.md)
99
2. [Execution](./docs/source/guides/execution.md)
1010
3. [Management](./docs/source/guides/management.md)
1111

12-
To learn more, click on each link. This represents the typical order that Nemo-Run users follow for setting up and launching experiments.
12+
To learn more, click on each link. This represents the typical order that NeMo Run users follow for setting up and launching experiments.
1313

14-
- [NeMo-Run](#nemo-run)
15-
- [Why Use Nemo-Run?](#why-use-nemo-run)
16-
- [Install NeMo-Run](#install-nemo-run)
14+
- [NeMo Run](#nemo-run)
15+
- [Why Use NeMo Run?](#why-use-nemo-run)
16+
- [Install NeMo Run](#install-nemo-run)
1717
- [Get Started](#get-started)
1818
- [Design Philosophy and Inspiration](#design-philosophy-and-inspiration)
1919
- [Pythonic](#pythonic)
@@ -22,14 +22,14 @@ To learn more, click on each link. This represents the typical order that Nemo-R
2222
- [Set Up Once and Scale Easily](#set-up-once-and-scale-easily)
2323
- [Tutorials](#tutorials)
2424
- [Hello world](#hello-world)
25-
- [Contribute to NeMo-Run](#contribute-to-nemo-run)
25+
- [Contribute to NeMo Run](#contribute-to-nemo-run)
2626
- [FAQs](#faqs)
2727

2828

29-
## Why Use Nemo-Run?
30-
Please see this [detailed guide](./docs/source/guides/why-use-nemo-run.md) for reasons to use Nemo-Run.
29+
## Why Use NeMo Run?
30+
Please see this [detailed guide](./docs/source/guides/why-use-nemo-run.md) for reasons to use NeMo Run.
3131

32-
## Install NeMo-Run
32+
## Install NeMo Run
3333
To install the project, use the following command:
3434

3535
```bash
@@ -39,7 +39,7 @@ pip install git+https://github.com/NVIDIA-NeMo/Run.git
3939
Make sure you have `pip` installed and configured properly.
4040

4141
## Get Started
42-
To get started with Nemo-Run, follow these three steps based on the core responsibilities mentioned above. For this example, we’ll showcase a pre-training example in Nemo 2.0 using Llama3.
42+
To get started with NeMo Run, follow these three steps based on the core responsibilities mentioned above. For this example, we’ll showcase a pre-training example in Nemo 2.0 using Llama3.
4343

4444
1. Configure your function:
4545
```python
@@ -60,7 +60,7 @@ run.run(partial_func, executor=local_executor, name="llama3_8b_pretraining")
6060
```
6161

6262
## Design Philosophy and Inspiration
63-
In building NeMo-Run, we drew inspiration from and relied on the following primary libraries. We would like to extend our gratitude for their work.
63+
In building NeMo Run, we drew inspiration from and relied on the following primary libraries. We would like to extend our gratitude for their work.
6464

6565
- [Fiddle](https://github.com/google/fiddle)
6666
- [TorchX](https://github.com/pytorch/torchx/)
@@ -72,25 +72,25 @@ In building NeMo-Run, we drew inspiration from and relied on the following prima
7272

7373
Apart from these, we also build on other libraries. A full list of dependencies can be found in [pyproject.toml](pyproject.toml).
7474

75-
NeMo-Run was designed keeping the following principles in mind:
75+
NeMo Run was designed keeping the following principles in mind:
7676

7777
### Pythonic
78-
In NeMo-Run, you can build and configure everything using Python, eliminating the need for multiple combinations of tools to manage your experiments. The only exception is when setting up the environment for remote execution, where we rely on Docker.
78+
In NeMo Run, you can build and configure everything using Python, eliminating the need for multiple combinations of tools to manage your experiments. The only exception is when setting up the environment for remote execution, where we rely on Docker.
7979

8080
### Modular
8181
The decoupling of task and executor allows you to form different combinations of execution units with relative ease. You configure different remote environments once, and you can reuse it across a variety of tasks in a Pythonic way.
8282

8383
### Opinionated but Flexible
84-
NeMo-Run is opinionated in some places, like storing of metadata information for experiments in a particular manner. However, it remains flexible enough to accommodate most user experiments.
84+
NeMo Run is opinionated in some places, like storing of metadata information for experiments in a particular manner. However, it remains flexible enough to accommodate most user experiments.
8585

8686
### Set Up Once and Scale Easily
87-
While it may take some time initially for users to become familiar with NeMo-Run concepts, the tool is designed to scale experimentation in a fluid and easy manner.
87+
While it may take some time initially for users to become familiar with NeMo Run concepts, the tool is designed to scale experimentation in a fluid and easy manner.
8888

8989
## Tutorials
9090

9191
#### Hello world
9292

93-
The `hello_world` tutorial series provides a comprehensive introduction to NeMo-Run, demonstrating its capabilities through a simple example. The tutorial covers:
93+
The `hello_world` tutorial series provides a comprehensive introduction to NeMo Run, demonstrating its capabilities through a simple example. The tutorial covers:
9494

9595
- Configuring Python functions using `Partial` and `Config` classes.
9696
- Executing configured functions locally and on remote clusters.
@@ -102,7 +102,7 @@ You can find the tutorial series below:
102102
- [Part 2](examples/hello-world/hello_experiments.ipynb).
103103
- [Part 3](examples/hello-world/hello_scripts.py).
104104

105-
## Contribute to NeMo-Run
105+
## Contribute to NeMo Run
106106
Please see the [contribution guide](./CONTRIBUTING.md) to contribute to NeMo Run.
107107

108108
## FAQs

0 commit comments

Comments
 (0)