Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating Readme to Use Correct Version of Protobuf #11

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shekhar316
Copy link
Contributor

Updating Readme to Use Correct Version of protobuf

Description

This PR will do the following changes -

  • updates the documentation to use correct version of protobuf library to avoid RayTaskError issues

Type of change

  • Refactoring Code
  • New feature
  • Documentation Update

How has this been tested?

Validated the version compatibility on Openshift-AI cluster using hpo-demos.

Test Configuration

  • Kubernetes clusters tested on: Openshift-AI Cluster

Checklist 🎯

  • Followed coding guidelines
  • Comments added
  • Dependent changes merged
  • Documentation updated
  • Tests added or updated

Additional information

  • RayTaskError clearly states to downgrade the protobuf version
TypeError: Descriptors cannot be created directly.
If this call came from a _pb2.py file, your generated code is out of date and must be regenerated with protoc >= 3.19.0.
If you cannot immediately regenerate your protos, some other possible workarounds are:
 1. Downgrade the protobuf package to 3.20.x or lower.
 2. Set PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python (but this will use pure-Python parsing and will be much slower).
 3. More information: https://developers.google.com/protocol-buffers/docs/news/2022-05-06#python-updates 

Copy link
Contributor

@kusumachalasani kusumachalasani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

## Troubleshooting

- **RayTaskError or TypeError stating "Descriptors cannot be created directly."**
This error indicates compatibility issues with the protobuf library version used in your project. While initializing the Ray cluster, you need to specify `protobuf` version `3.20.1` in the `runtime_env` parameter during Ray initialization. This ensures that the correct version of `protobuf` is used, avoiding the `RayTaskError` issues.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3.20.1 is only relevant for certain versions of ray right? It would be better to specify both the compatible versions together

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.

3 participants