chore: readme and pyproject tomlupdate for pypi packaging#9
Merged
dennislwei merged 2 commits intoIBM:mainfrom Oct 11, 2025
Merged
chore: readme and pyproject tomlupdate for pypi packaging#9dennislwei merged 2 commits intoIBM:mainfrom
dennislwei merged 2 commits intoIBM:mainfrom
Conversation
Signed-off-by: Inge Vejsbjerg<ingevejs@ie.ibm.com>
dennislwei
reviewed
Oct 9, 2025
Member
There was a problem hiding this comment.
Thanks @ingelise. I left some minor comments on the README that will be very quick to fix.
README.md
Outdated
| ``` | ||
| Download the spacy models for use in the project | ||
| ``` | ||
| uv run python -m spacy download en_core_web_trf |
Member
There was a problem hiding this comment.
'en_core_web_trf' is repeated. One of them should be 'en_core_web_sm'.
README.md
Outdated
| uv venv --python 3.12 | ||
| source .venv/bin/activate | ||
| uv pip install . | ||
| uv run python -m spacy download en_core_web_trf |
README.md
Outdated
| uv venv --python 3.12 | ||
| .venv/bin/activate | ||
| uv pip install . | ||
| uv run python -m spacy download en_core_web_trf |
README.md
Outdated
|
|
||
| 3. **Token Highlighter: Inspecting and Mitigating Jailbreak Prompts for Large Language Models**: Explains potential jailbreak threats by highlighting important prompt tokens based on model gradients. [](https://arxiv.org/pdf/2412.18171) [](https://colab.research.google.com/github/IBM/ICX360/blob/main/examples/th/quick_start.ipynb) | ||
|
|
||
| ## Download package from pypi |
Member
There was a problem hiding this comment.
Could we please change this to "Install package from PyPI" since it includes both downloading and installing?
README.md
Outdated
| ``` | ||
|
|
||
|
|
||
| ## Download from repo |
Member
There was a problem hiding this comment.
Similarly "Install from repo"
README.md
Outdated
| ## Download from repo | ||
|
|
||
|
|
||
| ## Prerequisites |
Member
There was a problem hiding this comment.
I think this heading should be ### Prerequisites because it's a heading under ## Install from repo. Similarly ## Installation -> ### Installation below.
Signed-off-by: Inge Vejsbjerg<ingevejs@ie.ibm.com>
Member
Author
|
Thanks @dennislwei, I have updated these errors. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the readmes and pyproject.toml file for pypi packaging.