| --- |
| license: mit |
| language: |
| - ca |
| - 'no' |
| - eu |
| - es |
| - en |
| metrics: |
| - f1 |
| widget: |
| - text: Best holidays ever ! |
| library_name: supar |
| tags: |
| - supar |
| - SemEval-2022-Task-10 |
| - structured-sentiment-analysis |
| - sentiment-analysis |
| base_model: |
| - facebook/xml-roberta-base |
| --- |
| # Model Card for Model ID |
|
|
| <!-- Provide a quick summary of what the model is/does. --> |
|
|
| <!-- This modelcard aims to be a base template for new models. |
| It has been generated using |
| [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/modelcard_template.md?plain=1). |
| --> |
| Structured Sentiment Analysis (SemEval-2022 Task 10) as Semantic Dependency Parsing. |
|
|
| # Model Details |
|
|
| ## Model Description |
|
|
| <!-- Provide a longer summary of what this model is. --> |
|
|
|
|
|
|
| - **Developed by:** Agüero-Torales, Marvin M. & Vilares, David. |
| <!-- - **Shared by [optional]:** [More Information Needed]--> |
| - **Model type:** Semantic Dependency Parsing. |
| - **Language(s) (NLP):** English, Spanish, Catalan, Basque, and Norwegian. |
| - **License:** MIT. |
| - **Finetuned from model [optional]:** __xml-roberta-base__, infoxlm-base, cardiffnlp/twitter-xlm-roberta-base-sentiment, bert-base-multilingual-cased, dccuchile/bert-base-spanish-wwm-cased, NbAiLab/nb-bert-base, PlanTL-GOB-ES/roberta-base-ca, ixa-ehu/berteus-base-cased. |
|
|
| ## Model Sources |
| <!-- [optional] --> |
|
|
| <!-- Provide the basic links for the model. --> |
|
|
| - **Repository:** [structured-sentiment-analysis-bis](https://github.com/mmaguero/structured-sentiment-analysis-bis). |
| <!-- - **Paper [optional]:** [More Information Needed] |
| - **Demo [optional]:** [More Information Needed] --> |
|
|
| # Uses |
|
|
| <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. --> |
|
|
| ## Direct Use |
|
|
| <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. --> |
| Structured Sentiment Analysis. |
|
|
| <!-- [More Information Needed] --> |
|
|
| <!-- |
| ## Downstream Use [optional] |
|
|
| <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app --> |
|
|
| <!-- |
| [More Information Needed] |
| --> |
|
|
| ## Out-of-Scope Use |
|
|
| <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. --> |
| This model is specific for Structured Sentiment Analysis on social media texts. |
|
|
| <!-- [More Information Needed] --> |
|
|
| # Bias, Risks, and Limitations |
|
|
| <!-- This section is meant to convey both technical and sociotechnical limitations. --> |
|
|
| <!-- [More Information Needed] --> |
|
|
| This model is specific for Structured Sentiment Analysis on social media texts. |
|
|
| ## Recommendations |
|
|
| <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. --> |
|
|
| Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. |
| More information needed for further recommendations. |
|
|
| ## How to Get Started with the Model |
|
|
| Use the code below to get started with the model. |
|
|
| ``` |
| from supar import Parser |
| parser = Parser.load('models/opener_en/all/model_vi_es_roberta_6') |
| dataset = parser.predict('especially the team of the main restaurant was really professionell and nice.', lang='en', prob=True, verbose=True) |
| dataset[0], type(dataset[0]) |
| ``` |
|
|
| <!-- [More Information Needed] --> |
|
|
|
|
| # Training Details |
|
|
| ## Training Data |
|
|
| <!-- This should link to a Data Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. --> |
|
|
| [More Information Needed] |
|
|
| ## Training Procedure [optional] |
|
|
| <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. --> |
|
|
| ### Preprocessing |
|
|
| [More Information Needed] |
|
|
| ### Speeds, Sizes, Times |
|
|
| <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. --> |
|
|
| [More Information Needed] |
|
|
| # Evaluation |
|
|
| <!-- This section describes the evaluation protocols and provides the results. --> |
|
|
| ## Testing Data, Factors & Metrics |
|
|
| ### Testing Data |
|
|
| <!-- This should link to a Data Card if possible. --> |
|
|
| [More Information Needed] |
|
|
| ### Factors |
|
|
| <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. --> |
|
|
| [More Information Needed] |
|
|
| ### Metrics |
|
|
| <!-- These are the evaluation metrics being used, ideally with a description of why. --> |
|
|
| [More Information Needed] |
|
|
| ## Results |
|
|
| [More Information Needed] |
|
|
| ### Summary |
|
|
|
|
|
|
| # Model Examination [optional] |
|
|
| <!-- Relevant interpretability work for the model goes here --> |
|
|
| [More Information Needed] |
|
|
| # Environmental Impact |
|
|
| <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly --> |
|
|
| <!-- |
| Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700). |
|
|
| - **Hardware Type:** [More Information Needed] |
| - **Hours used:** [More Information Needed] |
| - **Cloud Provider:** [More Information Needed] |
| - **Compute Region:** [More Information Needed] |
| - **Carbon Emitted:** [More Information Needed] |
| --> |
|
|
| # Technical Specifications [optional] |
|
|
| ## Model Architecture and Objective |
|
|
| [More Information Needed] |
|
|
| ## Compute Infrastructure |
|
|
| [More Information Needed] |
|
|
| ### Hardware |
|
|
| [More Information Needed] |
|
|
| ### Software |
|
|
| [More Information Needed] |
|
|
| # Citation [optional] |
|
|
| <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. --> |
|
|
| **BibTeX:** |
|
|
| [More Information Needed] |
|
|
| **APA:** |
|
|
| [More Information Needed] |
|
|
| # Glossary [optional] |
|
|
| <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. --> |
|
|
| [More Information Needed] |
|
|
| # More Information [optional] |
|
|
| [More Information Needed] |
|
|
| # Model Card Authors [optional] |
|
|
| [More Information Needed] |
|
|
| # Model Card Contact |
|
|
| [More Information Needed] |
