Skip to content

docs: clarify Python version support for source installation - #77

Open
Roovelrz wants to merge 1 commit into
BAI-LAB:mainfrom
Roovelrz:docs/clarify-python-support
Open

docs: clarify Python version support for source installation#77
Roovelrz wants to merge 1 commit into
BAI-LAB:mainfrom
Roovelrz:docs/clarify-python-support

Conversation

@Roovelrz

Copy link
Copy Markdown

Summary

  • Clarify that Python 3.10 or 3.11 should be used when installing MemoryOS from source
  • Document the current Python 3.12 limitation caused by the pinned numpy==1.24.* dependency
  • Preserve the existing Python 3.10 Conda environment as the recommended setup

Motivation

Issue #76 reports an installation failure when using Python 3.12. The installation fails while processing numpy==1.24.* from memoryos-pypi/requirements.txt.

NumPy 1.24 supports Python 3.8 through 3.11, but the current README states Python >= 3.10. This can lead users to assume that Python 3.12 is supported.

This PR clarifies the currently supported environment without changing dependency versions. Upgrading NumPy may require broader compatibility testing across the project and is outside the scope of this documentation fix.

Changes

Updated the MemoryOS_PyPi Getting Started prerequisites in README.md to:

  • Recommend Python 3.10 or 3.11
  • Explain that Python 3.12 is not currently supported for source installation because of the pinned NumPy 1.24 dependency
  • Retain the existing Python 3.10 Conda setup command

Testing

  • Reproduced the reported installation failure with Python 3.12
  • Verified the README diff
  • Ran git diff --check
  • No application code or dependency files were changed

Related issue

Addresses #76

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant