Skip to content

Commit e10fc58

Browse files
authored
docs: update readme intro with more info and add build badge (#22)
1 parent efd8560 commit e10fc58

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
# ML Flashpoint
22

3+
[![Build and Test](https://github.com/google/ml-flashpoint/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/google/ml-flashpoint/actions/workflows/build_and_test.yml)
4+
35
A memory-first, lightning-fast, ready-to-use ML checkpointing library.
46

5-
For using the library, check out the [user documentation](https://google.github.io/ml-flashpoint).
7+
PyTorch DCP, Megatron-LM and NeMo 2.0 adapters are readily available for seamless integration, on top of our general core checkpointing library that can be used for custom integrations.
8+
9+
If interested in direct integration support with another framework, please let us know by creating a [feature request](https://github.com/google/ml-flashpoint/issues/new?template=feature_request.md) or upvoting an existing one!
10+
11+
For learning more about using the library and its performance, check out the [user documentation](https://google.github.io/ml-flashpoint).
612
Below you will find development instructions for contributors.
713

814
## Installation

0 commit comments

Comments
 (0)