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.

Sign up for GitHub

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

Jump to bottom

Simplify Installation explanation in the ReadME #21

Closed
EricKolibacz opened this issue May 31, 2023 · 0 comments
Closed

Simplify Installation explanation in the ReadME #21

EricKolibacz opened this issue May 31, 2023 · 0 comments
Assignees
@tuananhroman
Labels
documentation Improvements or additions to documentation

Comments

@EricKolibacz
Copy link
Collaborator

Description

Currently, there are two ways explained how to install maxi-lib both requiering to clone the entire github repo. It might be easier to just run

poetry add git+https://github.com/dailab/MAXi-XAI-lib.git

In addition, it should be explained how to install it through pip (because not everyone is using poetry):

pip install git+https://github.com/dailab/MAXi-XAI-lib.git

Because Tensorflow makes some issues, it might be necessary to mention that the python version in the pyproject.toml should be set to python = ">=3.8,<3.12" (#18 )

Minimum Acceptance Criteria

  • Reduce number of steps to install the package
  • Mention installation via pip
@EricKolibacz EricKolibacz added the documentation Improvements or additions to documentation label May 31, 2023
@tuananhroman tuananhroman self-assigned this Jun 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tuananhroman tuananhroman

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@EricKolibacz @tuananhroman