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

146 separate classification module from standard dependencies #149

Conversation

emlynjdavies
Copy link
Collaborator

@emlynjdavies emlynjdavies commented Oct 8, 2023

This PR creates optional dependencies for tensorflow, which are only needed for the Classification module.

Now, if the [steps.classify] step is not defined in the pipeline, particle classification is skipped and no probabilities are reported. This is implemented in a backwards-compatible way, and which allows pipelines to be run without a tensorflow installation when classification is not needed.

New installation option:

The installation of the classification dependencies can be done with:

poetry install --extras "classification"

or (for Apple silicon)

poetry install --extras "classification-arm64"

After deployment (merging), this will be:

pip install pyopia[classification]

or (for Apple silicon)

pip install pyopia[claassification-arm64]

Other changes

  • Additional documentation improvements, and CITATION.cff are also included in this PR

@emlynjdavies emlynjdavies self-assigned this Oct 8, 2023
@emlynjdavies emlynjdavies linked an issue Oct 8, 2023 that may be closed by this pull request
@emlynjdavies emlynjdavies added the dependencies Pull requests that update a dependency file label Oct 9, 2023
@emlynjdavies emlynjdavies added documentation Improvements or additions to documentation patch / enhancement improved functionality or patch indented for changes that require bumping only the PATCH number labels Oct 9, 2023
@emlynjdavies emlynjdavies marked this pull request as ready for review October 11, 2023 18:39
docs/intro.md Outdated Show resolved Hide resolved
@emlynjdavies emlynjdavies merged commit e7aaa1b into main Dec 6, 2023
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation patch / enhancement improved functionality or patch indented for changes that require bumping only the PATCH number
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Separate classification module from standard dependencies
2 participants