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

📝 Update documentation #13

Merged
merged 1 commit into from
Oct 6, 2022
Merged

Conversation

GabrielePicco
Copy link
Contributor

Documentation

Status Type ⚠️ Core Change Issue
Ready Refactor No -

Other changes

  • Small doc improvement

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
@GabrielePicco GabrielePicco merged commit 32798cf into main Oct 6, 2022
@GabrielePicco GabrielePicco deleted the feat/improve-documentation branch October 6, 2022 09:51
GabrielePicco added a commit that referenced this pull request Oct 28, 2022
* 🎉 First commit

* 👷 Build pages doc

* 🎉 First commit

* ✏️ Fix repo links

* 👷 Publish to pypi on release

* 📝 Update Readme.md

* 📝 Update Readme.md

* 👷 Update pypi info

* 👷 Add manual deploy

* 📄 Version tag

* 📄 Update version tag

* 📄 Add pypi long description

* ✏️ Fix typo

* 🎨 Improve doc for pypi

* 📝 Update index

* Delete graph.png

* 💫 Update logo

* ✅ Add python tests

* ⚡ [ImgBot] Optimize images (#1)

*Total -- 392.70kb -> 298.54kb (23.98%)

/docs/img/annotations.png -- 79.47kb -> 49.25kb (38.03%)
/docs/img/graph.png -- 4.94kb -> 3.10kb (37.11%)
/docs/img/zshot-header.png -- 243.67kb -> 193.55kb (20.57%)
/docs/img/blink.png -- 64.62kb -> 52.64kb (18.54%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

* 👷 Update python tests

* 📝 Update README.md

* 📝 Update index.md

* ✅ Add codescan action

* ✅ Add code coverage

* 📝 Update Readme.md

* 📝 Update Readme.md

* 🐛 Fixed TypeError when printing DatasetWithEntities (#4)

Signed-off-by: Marcos Martinez <Marcos.Martinez.Galindo@ibm.com>

* 🐛 Fix displacy render function (#10)

* 🐛 Fix displacy render

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

* ✅ Add displacy test

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>

* 🔖 v0.0.2

* 📝 Update Readme.md (#13)

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>

* ✅ Evaluation tests improvement (#5)

* ✅ Added datasets tests. Added Mentions extractor pipeline and evaluator tests
* 👷 Add action cache
* 🩹 Remove cache after tests passed
* 🔨 Updated load_medmentions to load from hub
* 🗃️ Use org medmentionsZS

Signed-off-by: Marcos Martinez <Marcos.Martinez.Galindo@ibm.com>
Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

* 📝 Update logo

* ♻️ Remove unused code & host Smxm model on HG hub (#14)

* ♻️ Remove unused code

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* 👷 Add CI cache

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* 👷 Update codecov action

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* ♻️ Download smxm from the hugginface hub

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* ♻️ Use models from IBM org on HG hub

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* ⚡ Improve coverage

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* 🎨 Fix code style

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>
Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>

* ➖ delete unused file

* Feat/zshot version (#17)

* 🎨 Improved structure of setup and init.
* ✏️ Fixed minor typos and format in evaluator
* ✅ Update evaluation tests to work with latest version of evaluate
* 🐛 Fixed bug while importing version

* 🎨 Add RE visualization

* 🎨 Fix styling

* 🐛 Fix spans conversion to Spacy ent (#20)

* 🐛 Fix pipeline setup

* 🐛 Fix alignment

* 🐛 Fix import

* 🎨 Code style

* 🐛 Remove appdata

* 🐛 Fix displacy test

Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>
Co-authored-by: Gabriele Picco <piccogabriele@gmail.com>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: Marcos Martinez <marcosmartinezgalindo@gmail.com>
GabrielePicco added a commit that referenced this pull request Oct 28, 2022
Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>
GabrielePicco added a commit that referenced this pull request Oct 28, 2022
* 🎉 First commit

* 👷 Build pages doc

* 🎉 First commit

* ✏️ Fix repo links

* 👷 Publish to pypi on release

* 📝 Update Readme.md

* 📝 Update Readme.md

* 👷 Update pypi info

* 👷 Add manual deploy

* 📄 Version tag

* 📄 Update version tag

* 📄 Add pypi long description

* ✏️ Fix typo

* 🎨 Improve doc for pypi

* 📝 Update index

* Delete graph.png

* 💫 Update logo

* ✅ Add python tests

* ⚡ [ImgBot] Optimize images (#1)

*Total -- 392.70kb -> 298.54kb (23.98%)

/docs/img/annotations.png -- 79.47kb -> 49.25kb (38.03%)
/docs/img/graph.png -- 4.94kb -> 3.10kb (37.11%)
/docs/img/zshot-header.png -- 243.67kb -> 193.55kb (20.57%)
/docs/img/blink.png -- 64.62kb -> 52.64kb (18.54%)

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>

Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

* 👷 Update python tests

* 📝 Update README.md

* 📝 Update index.md

* ✅ Add codescan action

* ✅ Add code coverage

* 📝 Update Readme.md

* 📝 Update Readme.md

* 🐛 Fixed TypeError when printing DatasetWithEntities (#4)

Signed-off-by: Marcos Martinez <Marcos.Martinez.Galindo@ibm.com>

* 🐛 Fix displacy render function (#10)

* 🐛 Fix displacy render

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

* ✅ Add displacy test

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>

* 🔖 v0.0.2

* 📝 Update Readme.md (#13)

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>

* ✅ Evaluation tests improvement (#5)

* ✅ Added datasets tests. Added Mentions extractor pipeline and evaluator tests
* 👷 Add action cache
* 🩹 Remove cache after tests passed
* 🔨 Updated load_medmentions to load from hub
* 🗃️ Use org medmentionsZS

Signed-off-by: Marcos Martinez <Marcos.Martinez.Galindo@ibm.com>
Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>

* 📝 Update logo

* ♻️ Remove unused code & host Smxm model on HG hub (#14)

* ♻️ Remove unused code

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* 👷 Add CI cache

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* 👷 Update codecov action

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* ♻️ Download smxm from the hugginface hub

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* ♻️ Use models from IBM org on HG hub

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* ⚡ Improve coverage

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

* 🎨 Fix code style

Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>

Signed-off-by: Gabriele Picco <gabriele.picco@ibm.comm>
Signed-off-by: Gabriele Picco <piccogabriele@gmail.com>
Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>

* ➖ delete unused file

* Feat/zshot version (#17)

* 🎨 Improved structure of setup and init.
* ✏️ Fixed minor typos and format in evaluator
* ✅ Update evaluation tests to work with latest version of evaluate
* 🐛 Fixed bug while importing version

* 🎨 Add RE visualization

* 🎨 Fix styling

* 🐛 Fix spans conversion to Spacy ent (#20)

* 🐛 Fix pipeline setup

* 🐛 Fix alignment

* 🐛 Fix import

* 🎨 Code style

* 🐛 Remove appdata

* 🐛 Fix displacy test

Co-authored-by: Gabriele Picco <gabriele.picco@ibm.comm>
Co-authored-by: Gabriele Picco <piccogabriele@gmail.com>
Co-authored-by: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
Co-authored-by: Marcos Martinez <marcosmartinezgalindo@gmail.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.

None yet

1 participant