docs: Clarify installation instructions for running examples#354
Open
natinew77-creator wants to merge 1 commit intogoogle-deepmind:masterfrom
Open
docs: Clarify installation instructions for running examples#354natinew77-creator wants to merge 1 commit intogoogle-deepmind:masterfrom
natinew77-creator wants to merge 1 commit intogoogle-deepmind:masterfrom
Conversation
This PR addresses issue google-deepmind#297 by updating the README to: 1. Add a prominent warning that the PyPI package may be outdated 2. Recommend installing from source as the primary method for running examples 3. Reorganize installation steps to emphasize source installation 4. Add troubleshooting note for import errors after pip install The PyPI package (dm-acme) was last updated in February 2022, while the GitHub repository has continued to evolve with new agents and features. This mismatch causes import errors when users try to run the examples after installing via pip. Fixes google-deepmind#297
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses issue #297 by updating the README installation instructions to help users avoid import errors when running examples.
Problem
Users who install
dm-acmevia pip and try to run the examples encounter import errors like:This happens because the PyPI package was last updated in February 2022, while the GitHub repository has continued to evolve with new agents and features.
Solution
Updated the README.md to:
Changes
README.md: Reorganized installation section with clearer guidanceFixes #297This PR addresses issue #297 by updating the README to:
The PyPI package (dm-acme) was last updated in February 2022, while the GitHub repository has continued to evolve with new agents and features. This mismatch causes import errors when users try to run the examples after installing via pip.
Fixes #297