Skip to content

Commit 1f72bfa

Browse files
committed
mention core library and infra agnosticism
1 parent 3caf4e7 commit 1f72bfa

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# ML Flashpoint
22

33
ML Flashpoint is a memory-first, lightning-fast, ready-to-use ML checkpointing library.
4+
It is infrastructure and scheduler agnostic, with native integrations for certain frameworks, and a core library for custom use cases.
45

56
Check out the [User Guide](user-guide.md) to get started.
67

docs/user-guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# User Guide
22

33
Below are instructions for using ML Flashpoint with the different frameworks supported.
4+
For finer-grain control, use the [core](https://github.com/google/ml-flashpoint/tree/main/src/ml_flashpoint/core) library APIs, which the framework adapters build on top of.
5+
The adapters also provide a good working example of how to use the core library.
6+
7+
If interested in a native integration 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](https://github.com/google/ml-flashpoint/issues?q=is%3Aissue%20state%3Aopen%20label%3Aenhancement).
48

59
## Install
610

0 commit comments

Comments
 (0)