HAP transform: Update README.md and add sample notebook

[ian-cho]

update readme for hap transform

Related issue number (if any).

#753

[shahrokhDaijavad]

Thank you, @ian-cho. The README looks good. Three requests:

1. Can you please add a "Contributors" section with your name and email at the top like this: https://github.com/IBM/data-prep-kit/tree/update-doc_quality-readme/transforms/language/doc_quality/python?
2. The link to the test_hap.py file seems to be broken.
3. We have now finalized the format of the example notebook. Can you please create one like this: https://github.com/IBM/data-prep-kit/blob/update-doc_quality-readme/transforms/language/doc_quality/doc_quality.ipynb? Of course, the content will be similar to what you have in hap_local_python.py and some text from your README about the parameters. Thank you.

[shahrokhDaijavad]

Please see my comments.

[ian-cho]

@shahrokhDaijavad the links seem to be broken:

• https://github.com/IBM/data-prep-kit/tree/update-doc_quality-readme/transforms/language/doc_quality/python?
• https://github.com/IBM/data-prep-kit/blob/update-doc_quality-readme/transforms/language/doc_quality/doc_quality.ipynb

[shahrokhDaijavad]

Sorry, @ian-cho. After I gave you the links to the branch above, the branch was merged, so the new links are in the dev branch at:
https://github.com/IBM/data-prep-kit/blob/dev/transforms/language/doc_quality/python/README.md
and
https://github.com/IBM/data-prep-kit/blob/dev/transforms/language/doc_quality/doc_quality.ipynb

[ian-cho]

@shahrokhDaijavad Hi, I updated the PR as requested. Please review, thanks.

1. added contributor
2. For the link, replace it with notebook
3. added the hap python notebook.

[shahrokhDaijavad]

The link to the notebook is broken. The correct link is: ./hap_python.ipynb, because the notebook is in the python directory.

[shahrokhDaijavad]

Thank you, @ian-cho, for developing the minimal notebook that is functionally correct. For the consistency of your notebook with others, before the current cell one that imports the necessary packages, can you please add what we add in other notebooks, similar to what is here: https://github.com/IBM/data-prep-kit/blob/dev/transforms/language/doc_quality/doc_quality.ipynb?

[ian-cho]

@shahrokhDaijavad Thank you for further suggestions. Before code cells, I added markdown content and configurations for the hap transforms just as doc_quality.ipynb did. Please review.

[shahrokhDaijavad]

Thank you, @ian-cho. The notebook looks good. And what about the broken link in the README above?

[ian-cho]

Thank you, @ian-cho. The notebook looks good. And what about the broken link in the README above?

@shahrokhDaijavad Sorry, I missed that. Fixed it

[shahrokhDaijavad]

LGTM. Thank you, @ian-cho.