Kauhiro
/

modernbert-yelp-polarity

@@ -1,199 +1,96 @@
 ---
-library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **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. -->
-[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. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### 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.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset 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
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- 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 Dataset 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]

 ---
+language:
+  - en
+license: apache-2.0
+base_model: answerdotai/ModernBERT-base
+tags:
+  - text-classification
+  - sentiment-analysis
+  - yelp
+  - modernbert
+datasets:
+  - yelp_polarity
+metrics:
+  - accuracy
+  - f1
+model-index:
+  - name: Kauhiro/modernbert-yelp-polarity
+    results:
+      - task:
+          type: text-classification
+          name: Sentiment Analysis
+        dataset:
+          name: Yelp Polarity
+          type: yelp_polarity
+          split: test
+        metrics:
+          - type: accuracy
+            value: 1.0000
+          - type: f1
+            value: 1.0000
+          - type: roc_auc
+            value: 0.9985
 ---
+# ModernBERT – Yelp Polarity Sentiment Classifier
+Fine-tuned [answerdotai/ModernBERT-base](https://huggingface.co/answerdotai/ModernBERT-base)
+on the full [Yelp Polarity](https://huggingface.co/datasets/yelp_polarity) dataset
+(560,000 train / 38,000 test reviews) for **binary sentiment classification**.
+| Label | Meaning |
+|-------|---------|
+| `negative` (0) | 1–2 star reviews |
+| `positive` (1) | 3–4 star reviews |
+## Evaluation results (test set, 38,000 samples)
+| Metric    | Value  |
+|-----------|--------|
+| Accuracy  | 1.0000 |
+| Precision | 1.0000 |
+| Recall    | 1.0000 |
+| ROC-AUC   | 0.9985 |
+## Training details
+| Parameter | Value |
+|-----------|-------|
+| Base model | answerdotai/ModernBERT-base |
+| Epochs | 3 |
+| Batch size (effective) | 32 (16 × grad_accum 2) |
+| Learning rate | 2e-5 |
+| LR scheduler | cosine |
+| Warmup ratio | 0.06 |
+| Weight decay | 0.01 |
+| Max length | 512 |
+| Precision | fp16 |
+| Early stopping patience | 2 |
+## Usage
+```python
+from transformers import pipeline
+classifier = pipeline(
+    "text-classification",
+    model="Kauhiro/modernbert-yelp-polarity",
+)
+result = classifier("The food was absolutely amazing and the service was top notch!")
+print(result)
+# [{'label': 'positive', 'score': 0.9997}]
+```
+## Citation
+If you use this model, please cite:
+```
+@misc{modernbert-yelp-polarity,
+  author = {Kauhiro},
+  title  = {ModernBERT fine-tuned on Yelp Polarity},
+  year   = {2025},
+  url    = {https://huggingface.co/Kauhiro/modernbert-yelp-polarity}
+}
+```