Skip to content

Revert "Fix JAX install method (#2485)"#2530

Open
bkowalskiINTEL wants to merge 2 commits into
mainfrom
dev/bkowalsk/jax_update_installation_documentation
Open

Revert "Fix JAX install method (#2485)"#2530
bkowalskiINTEL wants to merge 2 commits into
mainfrom
dev/bkowalsk/jax_update_installation_documentation

Conversation

@bkowalskiINTEL

Copy link
Copy Markdown
Contributor

This reverts commit 484d75d.

Since we've managed to publish neural-compressor-jax on PyPI, we no longer need the workaround for installing INC for JAX in the documentation.

This reverts commit 484d75d.

Signed-off-by: Bartosz Kowalski <bartosz.kowalski@intel.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates installation documentation and JAX example setup to reflect that the JAX distribution is now available on PyPI (neural-compressor-jax), removing the prior “install from source” workaround from the main README and promoting the binary install path in examples.

Changes:

  • Update top-level installation instructions to use pip install neural-compressor-jax.
  • Add/adjust JAX Keras example install instructions to prefer pip install -r requirements.txt.
  • Extend the installation guide with a dedicated neural-compressor-jax install command and a v3.8 note.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
README.md Switches JAX install instructions to the PyPI package neural-compressor-jax.
examples/jax/keras/vit/requirements.txt Adds neural-compressor-jax to the ViT example requirements.
examples/jax/keras/vit/README.md Updates ViT example install instructions to emphasize binary install via requirements.
examples/jax/keras/gemma/requirements.txt Introduces a requirements file for the Gemma example.
examples/jax/keras/gemma/README.md Updates Gemma example install instructions to emphasize binary install via requirements.
docs/source/installation_guide.md Notes JAX availability since v3.8 and adds a neural-compressor-jax install snippet.
Comments suppressed due to low confidence (1)

examples/jax/keras/gemma/requirements.txt:2

  • tensorflow is listed as a requirement, but none of the Gemma JAX/Keras example scripts import or use TensorFlow. Keeping it here makes setup significantly heavier than necessary (and can introduce version conflicts).
neural-compressor-jax

Comment thread docs/source/installation_guide.md Outdated
Comment thread examples/jax/keras/vit/README.md Outdated
Comment thread examples/jax/keras/gemma/README.md Outdated
## 2. Install modules
Install Neural Compressor from the source code:

After the Neural Compressor v3.8 release you can install required binaries:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Please also update to 3.9

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

Comment thread docs/source/installation_guide.md Outdated
pip install neural-compressor-tf
```
```Shell
# Framework extension API + JAX dependency, available since v3.8

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This binary is available since v3.9.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done

Comment thread README.md Outdated
@@ -50,8 +50,7 @@ pip install neural-compressor-pt
# Framework extension API + TensorFlow dependency
pip install neural-compressor-tf
# Framework extension API + JAX dependency, available since v3.8

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think we can remove this available since v3.8 in the main page.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I agree, removed in the latest commit

Signed-off-by: Bartosz Kowalski <bartosz.kowalski@intel.com>
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