Skip to content

Commit 46ab276

Browse files
authored
Merge pull request #441 from lukaszstolarczuk/wip-disclaimer
[Docs] Add WIP disclaimer
2 parents 9f1fd53 + 0dfce8d commit 46ab276

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@
1515

1616
The Unified Memory Framework (UMF) is a library for constructing allocators and memory pools. It also contains broadly useful abstractions and utilities for memory management. UMF allows users to manage multiple memory pools characterized by different attributes, allowing certain allocation types to be isolated from others and allocated using different hardware resources as required.
1717

18+
**⚠️ Work-In-Progress disclaimer:**
19+
> Please note that this project is **pre-production software**, it should not be considered complete or fully functional.
20+
> It has not been fully tested yet (including security testing). It is not recommended to be used in production
21+
> as part of a larger system. It is not eligible for Intel® Bug Bounty Program.
22+
>
23+
> The API is not yet stable, may change without notice, and will not maintain backward compatibility.
24+
1825
## Usage
1926

2027
For a quick introduction to UMF usage, please see

scripts/docs_config/introduction.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ distribution among memory tiers and further data migration. Unenlightened
2222
applications do not require any code modifications and rely on underlying
2323
infrastructure. An underlying infrastructure refers not only to the OS with
2424
various memory tiering solutions to migrate memory pages between tiers, but
25-
also middleware: frameworks and libraries.
25+
also middleware: frameworks and libraries.
26+
27+
Please note that UMF is a Work-In-Progress! Read the disclaimer
28+
about that in the `README.md`_ file, before using our project.
2629

2730
==============
2831
Architecture

0 commit comments

Comments
 (0)