Metadata-Version: 2.1
Name: NudeNet
Version: 1.0.5
Summary: An ensemble of Neural Nets for Nudity Detection and Censoring
Home-page: https://github.com/bedapudi6788/NudeNet
Author: BEDAPUDI PRANEETH
Author-email: praneethbedapudi@gmail.com
License: GPLv3
Description: 
        # NudeNet: An ensemble of Neural Nets for Nudity Detection and Censoring
        
        
        
        [![DOI](https://zenodo.org/badge/173154449.svg)](https://zenodo.org/badge/latestdoi/173154449)
        
        
        Demo of the classifier available at http://bpraneeth.com/projects/nudenet
        
        
        Pre-trained models available at https://github.com/bedapudi6788/NudeNet-models/
        
        Uncensored version of the following image can be found at https://i.imgur.com/rga6845.jpg (NSFW)
        
        ![](https://i.imgur.com/2mhyqnt.jpg)
        
        Classification scores on the data available at https://dataturks.com/projects/Mohan/NSFW(Nudity%20Detection)%20Image%20Moderation%20Datatset
        ![](https://i.imgur.com/lXvvsdN.jpg)
        
        # Classification Classes
        
        nude -> image contains nudity
        
        safe -> image doesn't contain nudity
        
        # Detection Classes
        BELLY -> exposed belly (both male and female)
        
        BUTTOCKS -> exposed buttocks (both male and female)
        
        F_BREAST -> exposed female breast
        
        F_GENITALIA -> exposed female genitalia
        
        M_GENETALIA -> exposed male genetalia
        
        M_BREAST -> exposed male breast
        
        # Insallation
        ```
        pip install nudenet
        or
        pip install git+https://github.com/bedapudi6788/NudeNet
        ```
        
        # Classifier Usage
        ```
        from nudenet import NudeClassifier
        classifier = NudeClassifier('classifier_checkpoint_path')
        classifier.classify('path_to_nude_image')
        # {'path_to_nude_image': {'safe': 5.8822202e-08, 'nude': 1.0}}
        ```
        
        # Detector Usage
        ```
        from nudenet import NudeDetector
        detector = NudeDetector('detector_checkpoint_path')
        
        # Performing detection
        detector.detect('path_to_nude_image')
        # [{'box': [352, 688, 550, 858], 'score': 0.9603578, 'label': 'BELLY'}, {'box': [507, 896, 586, 1055], 'score': 0.94103414, 'label': 'F_GENITALIA'}, {'box': [221, 467, 552, 650], 'score': 0.8011624, 'label': 'F_BREAST'}, {'box': [359, 464, 543, 626], 'score': 0.6324697, 'label': 'F_BREAST'}]
        
        # Censoring an image
        detector.censor('path_to_nude_image', out_path='censored_image_path', visualize=False)
        
        ```
        
        # Classifier data available at https://archive.org/details/NudeNet_classifier_dataset_v1
        
        # To Do:
        1. Improve Documentation for the functions. (Right now user has to see the function definition to understand all the params)
        2. Convert these models into tflite, tfjs and create another repo that used tfjs to perform in browser detection and censor.
        
        # Note: Entire credit for collecting the object recognition dataset goes to http://www.cti-community.net/ (NSFW). The link for their api and the discord are as follows API here: http://pury.fi/ Discord: https://discord.gg/k4qM4Jh
         
        
        # LICENSE:
        
        Although nudenet is licensed under GPL, if you want to use it commercially without open sourcing your code please email me or raise a issue in this repo so that I can provide you explicit written permission to use as you wish. The only reason for doing this is, it would be nice to know if some company is using my work.
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
