Metadata-Version: 2.1
Name: mudes
Version: 0.3.0
Summary: Toxic Spans Prediction
Home-page: https://github.com/TharinduDR/MUDES
Author: Tharindu Ranasinghe
Author-email: rhtdranasinghe@gmail.com
License: UNKNOWN
Description: [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) 
        [![PyPI version](https://img.shields.io/pypi/v/mudes?color=%236ecfbd&label=pypi%20package&style=flat-square)](https://pypi.org/project/mudes/)
        [![Downloads](https://pepy.tech/badge/mudes)](https://pepy.tech/project/mudes)
        # MUDES - {Mu}ltilingual {De}tection of Offensive {S}pans
        
        We provide state-of-the-art models to detect toxic spans in text. We have evaluated our models on  Toxic Spans task at SemEval 2021 (Task 5).
        
        ## Installation
        You first need to install PyTorch. The recommended PyTorch version is 1.6.
        Please refer to [PyTorch installation page](https://pytorch.org/get-started/locally/#start-locally) regarding the specific install command for your platform.
        
        When PyTorch has been installed, you can install MUDES from pip. 
        
        #### From pip
        
        ```bash
        pip install mudes
        ```
        
        ## Pretrained MUDES Models
        
        We will be keep releasing new models. Please keep in touch. We have evaluated the models on the trial set released for Toxic Spanstask at SemEval 2021.
        
        | Models               | Average F1    |
        |----------------------|:-------------:|
        | en-base              | 0.6734        |
        | en-large             | 0.6886        |
        | multilingual-base    | 0.5953        |
        | multilingual-large   | 0.6013        |
        
        ## Prediction
        Following code can be used to predict toxic spans in text. Upon executing, it will download the relevant model and return the toxic spans.   
        
        ```python
        from mudes.app.mudes_app import MUDESApp
        
        app = MUDESApp("en-large", use_cuda=False)
        print(app.predict_toxic_spans("You motherfucking cunt", spans=True))
        
        ```
        
        ## System Demonstration
        An experimental demonstration interface called MUDES-UI has been released on [GitHub](https://github.com/TharinduDR/MUDES-UI) and can be checked out in [here](http://rgcl.wlv.ac.uk/mudes/).
        
        
        ## Citing & Authors
        If you are using this repo, please consider citing these papers.
        
        ```bash
        @inproceedings{ranasinghemudes,
         title={{MUDES: Multilingual Detection of Offensive Spans}}, 
         author={Tharindu Ranasinghe and Marcos Zampieri},  
         booktitle={Proceedings of NAACL},
         year={2021}
        }
        ```
        
        ```bash
        @inproceedings{ranasinghe2021semeval,
          title={{WLV-RIT at SemEval-2021 Task 5: A Neural Transformer Framework for Detecting Toxic Spans}},
          author = "Ranasinghe, Tharindu  and Sarkar, Diptanu and Zampieri, Marcos and Ororbia, Alex",
          booktitle={Proceedings of SemEval},
          year={2021}
        }
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.6
Description-Content-Type: text/markdown
