Skip to content

Commit

Permalink
make links in readme absolute so they show up on pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
gshennvm committed Dec 4, 2023
1 parent 4ad44a6 commit aaff5f2
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -42,15 +48,25 @@ 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
- We will continue improving the stability of the PPO learning phase.
- 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)

0 comments on commit aaff5f2

Please sign in to comment.