Metadata-Version: 2.1
Name: genclf
Version: 0.0.1
Summary: Gender Classifier ML Package for classifying gender using firstname
Home-page: https://github.com/Jcharis/genclf
License: MIT
Keywords: gender classifier,jcharistech,genclf,machine learning
Author: JCharis
Author-email: jcharistech@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: joblib (>=0.14.0,<0.15.0)
Requires-Dist: scikit-learn (>=0.22.0,<0.23.0)
Project-URL: Repository, https://github.com/Jcharis/genclf
Description-Content-Type: text/markdown

## GenderClassifier Tool
+ Aim: using ML models as packages
+ Purpose: for classifying gender of individuals using their first names

### Installation
```bash
pip install genclf
```

### Usage
#### Basic usage
```python
>>> from genclf import GenderClassifier
>>> g = GenderClassifier()
>>> g.name = 'Jess'
>>> g.predict()
```

#### Loading Different Models
```python
>>> from genclf import GenderClassifier
>>> g = GenderClassifier()
>>> g.name = 'Jessica'
>>> g.load('nv')
>>> g.predict()
```

#### Using the Classify Method
```python
>>> from genclf import GenderClassifier
>>> g = GenderClassifier()
>>> g.load('nb')
>>> g.classify("David")
```

#### Check Gender
```python
>>> from genclf import GenderClassifier
>>> g = GenderClassifier()
>>> g.is_male("Mark")
```

```python
>>> from genclf import GenderClassifier
>>> g = GenderClassifier()
>>> g.is_female("Mary")
```

#### Requirements
+ Joblib
+ Scikit-learn

#### Maintainer
+ Jesse E.Agbe(JCharis)
+ Jesus Saves@JCharisTech
