Skip to content

Commit 7914499

Browse files
dccifacebook-github-bot
authored andcommitted
Add warning sign for early development
Summary: Clarify expectations around early development and reporting bugs. Reviewed By: jspisak Differential Revision: D75032118 fbshipit-source-id: 9644503d4474475d016967a72efc7bb4b4096919
1 parent bcef351 commit 7914499

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
# Getting started
1+
# Monarch
22

3-
## Installation
3+
**Monarch** is a distributed execution engine for PyTorch.
4+
5+
> ⚠️ **Early Development Warning**
6+
> Monarch is currently in an experimental stage. You should expect bugs, incomplete features, and APIs that may change in future versions. The project welcomes bugfixes, but to make sure things are well coordinated you should discuss any significant change before starting the work. It's recommended that you signal your intention to contribute in the issue tracker, either by filing a new issue or by claiming an existing one.
47
5-
TODO improve
8+
## Installation
69

710
```sh
811

0 commit comments

Comments
 (0)