Skip to content

Latest commit

 

History

History
77 lines (46 loc) · 2.69 KB

README.md

File metadata and controls

77 lines (46 loc) · 2.69 KB

genderize-names

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. License
  5. Contact

About The Project

This Project is a web-based teacher assistant. It helps by letting the teachers checkup the gender of the student's names so they know whether to call them with Mr. or Ms.

(back to top)

Getting Started

This project is loaded on github pages. to view it, please check out this link. To get started, after oppening the page you can follow the examples in the usage section.

(back to top)

Usage

Some additional usage examples are put in this section.

When we enter the website, The following page is shown:

image

If invalid names are entered, messages will pop-up accordingly.

otherwise, we can get an output as shown below (after pressing submit) . image

We can also save the answer in the local storage. From then on, the saved answer will be shown if we press the submit button too. To save a value, if one of the radio button choices are selected, then the selected value is saevd. if none are selected, then the predicted value is saved. If none are selected and there is no predicted value, then an appropriate pop-up message is shown to mention this.

picture below shows an example of how saved data is shown. (obviously, the saved data and predicted data values may not be the same!) image

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Niki Pourazin - @npourazin - [email protected]

Project Link: https://npourazin.github.io/genderize-names/

Project Source Link: https://github.com/npourazin/genderize-names

(back to top)