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

Hopsworks Python library installation documentation improvements #431

Merged
merged 3 commits into from
Jan 3, 2025

Conversation

SirOibaf
Copy link
Contributor

@SirOibaf SirOibaf commented Jan 2, 2025

  • Remove references to pip install hsfs and hsfs.connection()
  • Improve the documentation for the installation of the Python library (Including profiles)
  • Add documentation for the installation of the Java library

- Remmove references to pip install hsfs and hsfs.connection()
- Improve the documentation for the installation of the Python library (Including profiles)
- Add documentation for the installation of the Java library
Copy link
Contributor

@jimdowling jimdowling left a comment

Choose a reason for hiding this comment

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

A few typos, otherwise good.

docs/user_guides/client_installation/index.md Outdated Show resolved Hide resolved
docs/user_guides/client_installation/index.md Show resolved Hide resolved
pip install hsfs[python]
# or if using zsh
pip install 'hsfs[python]'
pip install hopsworks[python,great-expectations,polars]
Copy link
Contributor

Choose a reason for hiding this comment

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

Is Polars not just an extension of the python profile?
Is this not enough:
pip install hopsworks[polars,great-expectations]

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Doesn't look like from the project configuration: https://github.com/logicalclocks/hopsworks-api/blob/0c93c2ab91b3962a1bc45633def1e2320eb0f1d7/python/pyproject.toml#L91 - we had to put polars on its own profile because on certain VMs the instructions set is not available and importing polars was crashing import hopsworks

docs/user_guides/integrations/databricks/api_key.md Outdated Show resolved Hide resolved
docs/user_guides/integrations/databricks/configuration.md Outdated Show resolved Hide resolved
docs/user_guides/integrations/databricks/configuration.md Outdated Show resolved Hide resolved
docs/user_guides/integrations/databricks/configuration.md Outdated Show resolved Hide resolved
docs/user_guides/integrations/mlstudio_designer.md Outdated Show resolved Hide resolved
docs/user_guides/integrations/mlstudio_notebooks.md Outdated Show resolved Hide resolved
@SirOibaf SirOibaf merged commit 077ff52 into logicalclocks:main Jan 3, 2025
1 check passed
SirOibaf added a commit that referenced this pull request Jan 3, 2025
* Hopsworks Python library installation documentation improvements

- Remmove references to pip install hsfs and hsfs.connection()
- Improve the documentation for the installation of the Python library (Including profiles)
- Add documentation for the installation of the Java library

* Typo

* Fix for review
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