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

Update README.md #43

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+4 −2
Open

Update README.md #43

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1ceb87
Update README.md
PhidLarkson Oct 19, 2024
1bcfb3e
Update README.md
PhidLarkson Oct 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Kasa
English to Twi translation library/system being put together by the Ghana NLP team.
A python library/system to interact with the African language translation, STT (Speech to Text) and TTS (Text to Speech) models put together by the Ghana NLP team.
Copy link
Member

Choose a reason for hiding this comment

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

we will have to add more details here. For now the main idea is for the library to expose NLP tools for Low-resourced languages with a focus on African Languages. You can then include some minor details of features we have now, such as a module (khaya) for accessing the APIs.

Copy link
Author

Choose a reason for hiding this comment

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

Alright I have taken this into consideration, can I give a good summary of how the NLP tools work and then prolly link up a blog series I am putting together to go into more details on it?

Check it out here
https://pkwolffe.hashnode.dev/series/build-with-ghananlp

Copy link
Member

Choose a reason for hiding this comment

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

yeah that sounds like a plan. we can include that in a section "further reading". give it a try and lets review together


# Quickstart
Install Kasa directly from online link:
To use this, install Kasa directly from online link:
Copy link
Member

Choose a reason for hiding this comment

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

Since this is on pypi, we should be able to install with pip as well as from source. these options should be included

Copy link
Author

Choose a reason for hiding this comment

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

Alright so we should make reference to:
pip install Kasa
...rather than calling the github repository


1. `pip install git+https://github.com/GhanaNLP/kasa`

Expand Down Expand Up @@ -61,6 +61,8 @@ It is helpful to know the function of the following files when contributing:

*)`HISTORY.md` -- what functionality was added during each version/release, and what is planned to be added next/in the near future.

*)`contribution.md` -- Up to date set up and deveoper contribution guide.
Copy link
Member

Choose a reason for hiding this comment

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

type "developer"

Copy link
Author

Choose a reason for hiding this comment

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

Noted


*)`setup.py` -- specify dependencies for added methods here

*)`__init__.py` -- * import specification file, does not exist for now...
Expand Down
Loading