From 5d4d8e46a733ade36feb3d77e9e32a72a7571377 Mon Sep 17 00:00:00 2001 From: Mehdi Ali <33023925+mali-git@users.noreply.github.com> Date: Tue, 16 Jul 2024 11:14:10 +0200 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 34bd5640..c14e4c30 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ -

Modalities

+

+ Modalities +

+
Python Versions @@ -16,11 +19,11 @@ -# Getting Started +## Getting Started For training and evaluation a model, feel free to checkout [this](https://github.com/Modalities/modalities/blob/main/examples/getting_started/getting_started_example.md) getting started tutorial, in which we train a small, 60M-parameter GPT model on a tiny subset of the Redpajama V2 dataset. Also, see our Wiki and API reference documentation: https://modalities.github.io/modalities/ -# Installation +## Installation Create conda environment and activate it via ``` @@ -38,7 +41,7 @@ If you want to contribute, have a look at `CONTRIBUTING.md`. -# Usage +## Usage For running the training endpoint on multiple GPUs run `CUDA_VISIBLE_DEVICES=2,3 torchrun --nnodes 1 --nproc_per_node 2 --rdzv-endpoint=0.0.0.0:29502 src/modalities/__main__.py run --config_file_path config_files/config.yaml`. Or, if you are a VsCode user, add this to your `launch.json`: @@ -69,10 +72,10 @@ Or, if you are a VsCode user, add this to your `launch.json`: } ``` -# Supported Features +## Supported Features In the following, we list the already implemented, planned and in-progress features w.r.t. to improving downstream performance, throughput, multi-modality, and alignment. -## Throughput Features +### Throughput Features | Name | Status | Description | |---------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------| @@ -88,7 +91,7 @@ In the following, we list the already implemented, planned and in-progress featu -## Downstream Performance Features +### Downstream Performance Features | Name | Status | Description | |--------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------| @@ -161,7 +164,7 @@ in our `pyproject.toml`, we can start only main with `modalities` (which does no Alternatively, directly use `src/modalities/__main__.py do_stuff --config_file_path config_files/config.yaml --my_cli_argument 3537`. -# Contributing +## Contributing Modalities welcomes your contributions! Please check out our [contributing](CONTRIBUTING.md) guidelines regarding the details on formatting, testing,