From aaff5f215f849534af0df379e5e7809d08e4441f Mon Sep 17 00:00:00 2001 From: Gerald Shen Date: Sun, 3 Dec 2023 21:00:24 -0800 Subject: [PATCH] make links in readme absolute so they show up on pypi --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f315eaeaf..a4283bba9 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,15 @@ The toolkit is currently in it's early stages, and we are committed to improving * **Direct Preference Optimization as described in [paper](https://arxiv.org/pdf/2305.18290.pdf)** ## Learn More +<<<<<<< HEAD * [Documentation](./docs/README.md) * [Examples](./examples/nlp/gpt/) * [Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/latest/ModelAlignment/index.html) +======= +* [Documentation](https://github.com/NVIDIA/NeMo-Aligner/blob/main/docs/README.md) +* [Examples](https://github.com/NVIDIA/NeMo-Aligner/tree/main/examples/nlp/gpt) +* [Tutorials](https://docs.nvidia.com/nemo-framework/user-guide/latest/index.html): Please refer to the alignment section for step by step tutorials +>>>>>>> 3cca1eb (make links in readme absolute so they show up on pypi) ## Latest Release @@ -42,7 +48,17 @@ pip install . ### Docker Containers +<<<<<<< HEAD To build your own, refer to the [NeMo Dockerfile](https://github.com/NVIDIA/NeMo/blob/main/Dockerfile) and add `RUN pip install nemo-aligner` at the end. +======= +We release along with the NeMo toolkit containers. You may find more details about released containers in [releases page](https://github.com/NVIDIA/NeMo-Aligner/releases). + +To build your own, refer to the [Dockerfile](https://github.com/NVIDIA/NeMo/blob/main/Dockerfile) and add `RUN pip install nemo-aligner` at the end. + +## Release history + +For the list of changes within each release please see the [Changelog](https://github.com/NVIDIA/NeMo-Aligner/blob/main/CHANGELOG.md). +>>>>>>> 3cca1eb (make links in readme absolute so they show up on pypi) ## Future work - Add Rejection Sampling support @@ -50,7 +66,7 @@ To build your own, refer to the [NeMo Dockerfile](https://github.com/NVIDIA/NeMo - Improve the performance of RLHF ## Contributing -We welcome community contributions! Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. +We welcome community contributions! Please refer to [CONTRIBUTING.md](https://github.com/NVIDIA/NeMo-Aligner/blob/main/CONTRIBUTING.md) for guidelines. ## License -This toolkit is licensed under the [Apache License, Version 2.0.](LICENSE) +This toolkit is licensed under the [Apache License, Version 2.0.](https://github.com/NVIDIA/NeMo-Aligner/blob/main/LICENSE)