statworx
/

bert-base-german-cased-finetuned-swiss

@@ -7,44 +7,6 @@ license: apache-2.0
 Bert-base-german-cased model fine-tuned on a corpus of German-Swiss.
-#  Table of Contents
-- [Model Card for Bert-base-german-cased-finetuned-swiss](#model-card-for--model_id-)
-- [Table of Contents](#table-of-contents)
-- [Table of Contents](#table-of-contents-1)
-- [Model Details](#model-details)
-  - [Model Description](#model-description)
-- [Uses](#uses)
-  - [Direct Use](#direct-use)
-  - [Downstream Use [Optional]](#downstream-use-optional)
-  - [Out-of-Scope Use](#out-of-scope-use)
-- [Bias, Risks, and Limitations](#bias-risks-and-limitations)
-  - [Recommendations](#recommendations)
-- [Training Details](#training-details)
-  - [Training Data](#training-data)
-  - [Training Procedure](#training-procedure)
-    - [Preprocessing](#preprocessing)
-    - [Speeds, Sizes, Times](#speeds-sizes-times)
-- [Evaluation](#evaluation)
-  - [Testing Data, Factors & Metrics](#testing-data-factors--metrics)
-    - [Testing Data](#testing-data)
-    - [Factors](#factors)
-    - [Metrics](#metrics)
-  - [Results](#results)
-- [Model Examination](#model-examination)
-- [Environmental Impact](#environmental-impact)
-- [Technical Specifications [optional]](#technical-specifications-optional)
-  - [Model Architecture and Objective](#model-architecture-and-objective)
-  - [Compute Infrastructure](#compute-infrastructure)
-    - [Hardware](#hardware)
-    - [Software](#software)
-- [Citation](#citation)
-- [Glossary [optional]](#glossary-optional)
-- [More Information [optional]](#more-information-optional)
-- [Model Card Authors [optional]](#model-card-authors-optional)
-- [Model Card Contact](#model-card-contact)
-- [How to Get Started with the Model](#how-to-get-started-with-the-model)
 # Model Details
@@ -53,186 +15,10 @@ Bert-base-german-cased model fine-tuned on a corpus of German-Swiss.
 Bert-base-german-cased model fine-tuned on a corpus of German-Swiss.
 Fine-tuning was done on the Swiss German data of the [Leipzig Corpora Collection](https://wortschatz.uni-leipzig.de/en/download/) and [SwissCrawl](https://icosys.ch/swisscrawl). For testing purposes, the model was evaluated on the [Swiss Dialect Classification dataset](https://huggingface.co/datasets/statworx/swiss-dialects) as down-stream task.
-- **Developed by:** More information needed
-- **Shared by [Optional]:** More information needed
 - **Model type:** Language model
 - **Language(s) (NLP):** de
 - **License:** apache-2.0
-- **Parent Model:** More information needed
-- **Resources for more information:** 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. -->
-<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info 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 -->
-<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
-## Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-<!-- If the user enters content, print that. If not, but they enter a task in the list, use that. If neither, say "more info needed." -->
-# Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-Significant research has explored bias and fairness issues with language models (see, e.g., [Sheng et al. (2021)](https://aclanthology.org/2021.acl-long.330.pdf) and [Bender et al. (2021)](https://dl.acm.org/doi/pdf/10.1145/3442188.3445922)). Predictions generated by the model may include disturbing and harmful stereotypes across protected classes; identity characteristics; and sensitive, social, and occupational groups.
-## Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-# 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. -->
-https://huggingface.co/datasets/statworx/leipzip-swiss,
-https://icosys.ch/swisscrawl
-## Training Procedure
-<!-- 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
-# Model Examination
-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
-<!-- 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]
-<!-- This section provides another layer of transparency and accountability. Whose views is this model card representing? How many voices were included in its construction? Etc. -->
-F, a, b, i, a, n,  , M, ü, l, l, e, r
-# Model Card Contact
-More information needed
-# How to Get Started with the Model
-Use the code below to get started with the model.
-<details>
-<summary> Click to expand </summary>
-# ⚠️ Type of model unknown
-</details>

 Bert-base-german-cased model fine-tuned on a corpus of German-Swiss.
 # Model Details
 Bert-base-german-cased model fine-tuned on a corpus of German-Swiss.
 Fine-tuning was done on the Swiss German data of the [Leipzig Corpora Collection](https://wortschatz.uni-leipzig.de/en/download/) and [SwissCrawl](https://icosys.ch/swisscrawl). For testing purposes, the model was evaluated on the [Swiss Dialect Classification dataset](https://huggingface.co/datasets/statworx/swiss-dialects) as down-stream task.
+It outperformed its parent model ([bert-base-german-cased](https://huggingface.co/bert-base-german-cased)) by approx. 5% accuracy.
+- **Developed by:** Fabian Müller
 - **Model type:** Language model
 - **Language(s) (NLP):** de
 - **License:** apache-2.0
+- **Parent Model:** [bert-base-german-cased](https://huggingface.co/bert-base-german-cased)