gokulalex commited on
Commit
be6163e
·
verified ·
1 Parent(s): 152abe5

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +77 -184
README.md CHANGED
@@ -1,207 +1,100 @@
1
  ---
2
- base_model: mistralai/Mistral-7B-Instruct-v0.3
3
- library_name: peft
4
- pipeline_tag: text-generation
5
  tags:
6
- - base_model:adapter:mistralai/Mistral-7B-Instruct-v0.3
7
- - lora
8
- - transformers
 
 
 
 
 
 
 
 
9
  ---
10
 
11
- # Model Card for Model ID
12
-
13
- <!-- Provide a quick summary of what the model is/does. -->
14
-
15
-
16
-
17
- ## Model Details
18
 
19
- ### Model Description
20
 
21
- <!-- Provide a longer summary of what this model is. -->
 
 
22
 
 
23
 
 
24
 
25
- - **Developed by:** [More Information Needed]
26
- - **Funded by [optional]:** [More Information Needed]
27
- - **Shared by [optional]:** [More Information Needed]
28
- - **Model type:** [More Information Needed]
29
- - **Language(s) (NLP):** [More Information Needed]
30
- - **License:** [More Information Needed]
31
- - **Finetuned from model [optional]:** [More Information Needed]
32
 
33
- ### Model Sources [optional]
34
-
35
- <!-- Provide the basic links for the model. -->
36
-
37
- - **Repository:** [More Information Needed]
38
- - **Paper [optional]:** [More Information Needed]
39
- - **Demo [optional]:** [More Information Needed]
40
 
41
  ## Uses
42
 
43
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
44
-
45
  ### Direct Use
46
 
47
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
48
-
49
- [More Information Needed]
50
-
51
- ### Downstream Use [optional]
 
52
 
53
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
54
 
55
- [More Information Needed]
 
 
 
 
56
 
57
  ### Out-of-Scope Use
58
 
59
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
60
-
61
- [More Information Needed]
62
-
63
- ## Bias, Risks, and Limitations
64
-
65
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
66
-
67
- [More Information Needed]
68
-
69
- ### Recommendations
70
-
71
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
72
-
73
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
74
 
75
  ## How to Get Started with the Model
76
 
77
- Use the code below to get started with the model.
78
-
79
- [More Information Needed]
80
-
81
- ## Training Details
82
-
83
- ### Training Data
84
-
85
- <!-- 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. -->
86
-
87
- [More Information Needed]
88
-
89
- ### Training Procedure
90
-
91
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
92
-
93
- #### Preprocessing [optional]
94
-
95
- [More Information Needed]
96
-
97
-
98
- #### Training Hyperparameters
99
-
100
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
101
-
102
- #### Speeds, Sizes, Times [optional]
103
-
104
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
105
-
106
- [More Information Needed]
107
-
108
- ## Evaluation
109
-
110
- <!-- This section describes the evaluation protocols and provides the results. -->
111
-
112
- ### Testing Data, Factors & Metrics
113
-
114
- #### Testing Data
115
-
116
- <!-- This should link to a Dataset Card if possible. -->
117
-
118
- [More Information Needed]
119
-
120
- #### Factors
121
-
122
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
123
-
124
- [More Information Needed]
125
-
126
- #### Metrics
127
-
128
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
129
-
130
- [More Information Needed]
131
-
132
- ### Results
133
-
134
- [More Information Needed]
135
-
136
- #### Summary
137
-
138
-
139
-
140
- ## Model Examination [optional]
141
-
142
- <!-- Relevant interpretability work for the model goes here -->
143
-
144
- [More Information Needed]
145
-
146
- ## Environmental Impact
147
-
148
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
149
-
150
- 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).
151
-
152
- - **Hardware Type:** [More Information Needed]
153
- - **Hours used:** [More Information Needed]
154
- - **Cloud Provider:** [More Information Needed]
155
- - **Compute Region:** [More Information Needed]
156
- - **Carbon Emitted:** [More Information Needed]
157
-
158
- ## Technical Specifications [optional]
159
-
160
- ### Model Architecture and Objective
161
-
162
- [More Information Needed]
163
-
164
- ### Compute Infrastructure
165
-
166
- [More Information Needed]
167
-
168
- #### Hardware
169
-
170
- [More Information Needed]
171
-
172
- #### Software
173
-
174
- [More Information Needed]
175
-
176
- ## Citation [optional]
177
-
178
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
179
-
180
- **BibTeX:**
181
-
182
- [More Information Needed]
183
-
184
- **APA:**
185
-
186
- [More Information Needed]
187
-
188
- ## Glossary [optional]
189
-
190
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
191
-
192
- [More Information Needed]
193
-
194
- ## More Information [optional]
195
-
196
- [More Information Needed]
197
-
198
- ## Model Card Authors [optional]
199
-
200
- [More Information Needed]
201
-
202
- ## Model Card Contact
203
-
204
- [More Information Needed]
205
- ### Framework versions
206
-
207
- - PEFT 0.17.1
 
1
  ---
2
+ language:
3
+ - en
4
+ license: mit
5
  tags:
6
+ - invoice-extraction
7
+ - structured-data
8
+ - phi-3
9
+ - sft
10
+ - text-generation
11
+ - document-understanding
12
+ - financial-nlp
13
+ datasets:
14
+ - custom-invoice-dataset
15
+ pipeline_tag: text-generation
16
+ base_model: microsoft/Phi-3-mini-4k-instruct
17
  ---
18
 
19
+ # BrahmaNet: Phi-3 SFT for Invoice Extraction
 
 
 
 
 
 
20
 
21
+ <div align="center">
22
 
23
+ ![BrahmaNet Logo](https://img.shields.io/badge/BrahmaNet-Invoice%20Extraction-blue)
24
+ ![Phi-3](https://img.shields.io/badge/Base%20Model-Phi--3-green)
25
+ ![SFT](https://img.shields.io/badge/Method-Supervised%20Fine--Tuning-orange)
26
 
27
+ </div>
28
 
29
+ ## Model Description
30
 
31
+ **BrahmaNet** is a specialized language model fine-tuned from Microsoft's Phi-3-mini-4k-instruct for extracting structured information from invoice documents. The model is optimized to understand invoice formats and convert unstructured text into well-structured JSON output.
 
 
 
 
 
 
32
 
33
+ - **Developed by:** Gokul Alex
34
+ - **Model type:** Causal Language Model
35
+ - **Language(s):** English
36
+ - **License:** MIT
37
+ - **Finetuned from model:** [microsoft/Phi-3-mini-4k-instruct](https://huggingface.co/microsoft/Phi-3-mini-4k-instruct)
 
 
38
 
39
  ## Uses
40
 
 
 
41
  ### Direct Use
42
 
43
+ This model is designed for extracting structured information from invoice documents including:
44
+ - Invoice numbers and dates
45
+ - Supplier/vendor information
46
+ - Total amounts and line items
47
+ - Customer details
48
+ - Payment terms
49
 
50
+ ### Downstream Use
51
 
52
+ The model can be fine-tuned further for:
53
+ - Receipt processing
54
+ - Purchase order extraction
55
+ - Financial document analysis
56
+ - Custom structured data extraction tasks
57
 
58
  ### Out-of-Scope Use
59
 
60
+ - General purpose chat or conversation
61
+ - Mathematical reasoning beyond basic arithmetic
62
+ - Legal document analysis
63
+ - Medical or sensitive personal information extraction
 
 
 
 
 
 
 
 
 
 
 
64
 
65
  ## How to Get Started with the Model
66
 
67
+ ```python
68
+ from transformers import AutoTokenizer, AutoModelForCausalLM
69
+ import torch
70
+
71
+ # Load model and tokenizer
72
+ model_name = "gokulalex/BrahmaNet"
73
+ tokenizer = AutoTokenizer.from_pretrained(model_name, trust_remote_code=True)
74
+ model = AutoModelForCausalLM.from_pretrained(
75
+ model_name,
76
+ device_map="auto",
77
+ torch_dtype=torch.bfloat16,
78
+ trust_remote_code=True
79
+ )
80
+
81
+ # Prepare prompt
82
+ prompt = """Extract invoice information as JSON:
83
+
84
+ Document: Invoice Number: INV-2023-001, Date: 2023-10-15, Supplier: ABC Corporation, Total Amount: $1,250.00
85
+
86
+ JSON:"""
87
+
88
+ # Generate response
89
+ inputs = tokenizer(prompt, return_tensors="pt", max_length=512, truncation=True)
90
+ outputs = model.generate(
91
+ inputs.input_ids,
92
+ max_new_tokens=150,
93
+ do_sample=True,
94
+ temperature=0.3,
95
+ top_p=0.9,
96
+ pad_token_id=tokenizer.eos_token_id
97
+ )
98
+
99
+ response = tokenizer.decode(outputs[0], skip_special_tokens=True)
100
+ print(response)