letran1110
/

vit5_motor_extractor

@@ -1,199 +1,90 @@
 ---
 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]

 ---
+pipeline_tag: text2text-generation
 library_name: transformers
+tags:
+  - t5
+  - vietnamese
+  - information-extraction
+  - text2text-generation
 ---
+# ViT5 Motor Extractor
+## Model Card for `letran1110/vit5_motor_extractor`
+This is a fine-tuned [ViT5](https://huggingface.co/VietAI/vit5-base) model for extracting motor specifications from raw text descriptions. The model is trained to take in noisy or unstructured motor-related information and output structured key-value pairs such as power, voltage, poles, protection class, and more.
+---
+## 🧠 Model Details
+- **Model Type:** `T5ForConditionalGeneration`
+- **Language(s):** Vietnamese (primary), English (partially)
+- **Finetuned From:** `VietAI/vit5-base`
+- **License:** MIT
+- **Framework:** 🤗 Transformers
+---
+## 🔧 How to Use
+```python
+from transformers import AutoTokenizer, AutoModelForSeq2SeqLM
+tokenizer = AutoTokenizer.from_pretrained("letran1110/vit5_motor_extractor")
+model = AutoModelForSeq2SeqLM.from_pretrained("letran1110/vit5_motor_extractor")
+text = "Động cơ 3 pha 5.5kW, 4 cực, điện áp 380V, vỏ nhôm, bảo vệ IP55"
+inputs = tokenizer(text, return_tensors="pt")
+outputs = model.generate(**inputs)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
+## ✅ Intended Use
+This model is designed to help extract structured information from motor specification descriptions (both Vietnamese and partial English), useful in:
+- Inventory parsing
+- Industrial cataloging
+- Smart search & indexing for motor components
+## ❌ Out-of-Scope Use
+- Long-form document QA
+- General conversation
+- Image-based input (OCR must be done separately)
+## 📚 Training
+Dataset: Custom dataset crawled and annotated from motor product pages
+Epochs: 10
+Batch Size: 16
+Max Length: 512
+Optimizer: AdamW
+## 🧪 Evaluation
+Evaluation is manual by checking structured JSON outputs. Target fields include:
+- `motor_name`
+- `power`
+- `voltage`
+- `poles`
+- `protection`
+- `frame_size`
+- `shaft_diameter`
+- `material`
+## 🤝 Citation
+If you use this model, please cite the repo:
+```bibtex
+@misc{vit5motor2024,
+  title={ViT5 Motor Extractor},
+  author={letran1110},
+  year={2024},
+  howpublished={\url{https://huggingface.co/letran1110/vit5_motor_extractor}},
+}
+```