Commit 4191fb3
authored
Document that MemMachine integration is Experimental (#1854)
**Summary**
This PR marks the MemMachine integration as Experimental across runtime behavior, package metadata, and user-facing documentation to discourage production adoption until the integration is stabilized. The feature will be tested in v1.7.0 at which point the experimental markers can be dropped.
**What changed**
- Added runtime experimental warning for MemMachine memory registration:
- Applied @experimental(feature_name="MemMachine") to memmachine_memory_client.
- Added explicit Experimental warning text in MemMachine package docs:
- packages/nvidia_nat_memmachine/README.md
- packages/nvidia_nat_memmachine/src/nat/meta/pypi.md
- Added package maturity classifier:
- packages/nvidia_nat_memmachine/pyproject.toml
- Added Development Status :: 3 - Alpha.
- Updated toolkit docs to label MemMachine as Experimental:
- docs/source/get-started/installation.md
- docs/source/build-workflows/memory.md
- docs/source/build-workflows/workflow-configuration.md
- docs/source/components/agents/auto-memory-wrapper/auto-memory-wrapper.md
## By Submitting this PR I confirm:
- I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/NeMo-Agent-Toolkit/blob/develop/docs/source/resources/contributing/index.md).
- We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
- Any contribution which contains commits that are not Signed-Off will not be accepted.
- When the PR is ready for review, new or existing tests cover these changes.
- When the PR is ready for review, the documentation is up to date with these changes.
## Summary by CodeRabbit
* **Documentation**
* Marked the MemMachine memory backend as Experimental across docs, README, and PyPI/subpackage notes.
* Added warnings that the backend is not recommended for production and that behavior/APIs may change without notice.
* **Chores**
* Updated package metadata/classifiers to reflect alpha/experimental development status.
Authors:
- Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah)
Approvers:
- Will Killian (https://github.com/willkill07)
URL: #18541 parent ea09c9a commit 4191fb3
8 files changed
Lines changed: 13 additions & 4 deletions
File tree
- docs/source
- build-workflows
- components/agents/auto-memory-wrapper
- get-started
- packages/nvidia_nat_memmachine
- src/nat
- meta
- plugins/memmachine
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
27 | | - | |
| 27 | + | |
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
115 | | - | |
| 115 | + | |
116 | 116 | | |
117 | 117 | | |
118 | 118 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
44 | 44 | | |
45 | 45 | | |
46 | 46 | | |
47 | | - | |
| 47 | + | |
48 | 48 | | |
49 | 49 | | |
50 | 50 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
19 | 19 | | |
20 | 20 | | |
21 | 21 | | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
22 | 25 | | |
23 | 26 | | |
24 | 27 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
40 | 40 | | |
41 | 41 | | |
42 | 42 | | |
| 43 | + | |
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
23 | 26 | | |
24 | 27 | | |
Lines changed: 2 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| 23 | + | |
23 | 24 | | |
24 | 25 | | |
25 | 26 | | |
| |||
45 | 46 | | |
46 | 47 | | |
47 | 48 | | |
| 49 | + | |
48 | 50 | | |
49 | 51 | | |
50 | 52 | | |
| |||
0 commit comments