Skip to content

Commit

Permalink
Merge pull request #188 from Modalities/improve_readme
Browse files Browse the repository at this point in the history
Refactor: Improve Readme
  • Loading branch information
le1nux committed Jul 16, 2024
2 parents 1aa906b + 17ad17f commit 26366c8
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
# Modalities
<h1 style="text-align:center;">Modalities</h1>

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT')
[![Coverage Status](https://coveralls.io/repos/github/Modalities/modalities/badge.svg)](https://coveralls.io/github/Modalities/modalities)
<div align="center">
<img src="https://img.shields.io/badge/Python-3.10%20%7C%203.11-blue" alt="Python Versions">
<a href="https://pytorch.org/">
<img src="https://img.shields.io/badge/PyTorch-green?logo=pytorch&logoColor=white" alt="PyTorch">
</a>
<a href="https://coveralls.io/github/Modalities/modalities">
<img src="https://coveralls.io/repos/github/Modalities/modalities/badge.svg" alt="Coverage Status">
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License">
</a>
</div>



# 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/

Expand Down

0 comments on commit 26366c8

Please sign in to comment.