Update README.md

init model card for AdaParsev2

README.md

@@ -4,44 +4,27 @@ tags: []
 ---
 
 # Model Card for Model ID
-
-<!-- Provide a quick summary of what the model is/does. -->
-
-
+Text quality prediction (BLEU) for various document parsers given the first page's PyMuPDF-extracted text. 
+This model relates to the second version of AdaParse ("AdaParse v2").
 
 ## Model Details
+Allen AI's Specter fine-tuned for document quality prediction.
 
 ### Model Description
+- **Developed by:** Carlo Siebenschuh
 
-<!-- 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]
+### Model Sources
 
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Repository:** [AdaParse@GitHub](https://github.com/7shoe/AdaParse)
+- **Paper:** [AdaParse: An Adaptive Parallel PDF Parsing and Resource Scaling Engine](https://arxiv.org/abs/2505.01435)
+- **Presentation:** [MLSys25](https://mlsys.org/virtual/2025/session/3141)
 
 ## 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. -->
+Predict quality of parser output given the extracted text/
 
 ### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
+Document quality prediction for resource-optimal delegation within AdaParse (version 2 for this particular instance).
 
 ### Downstream Use [optional]
 
@@ -50,22 +33,15 @@ This is the model card of a 🤗 transformers model that has been pushed on the
 [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]
+Quality prediction for documents that are (a.) out-of-distribution (e.g., non-scientific) or (b.) for parsers that were not part of the fine-tunign set.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+**Bias**: Model was trained on tens of thousands of scientific documents from several journals across eight scientific disciplines (mathematics, engineering, biology, physics, etc.). Naturally, biased towards STEM documents.
+**Limitations**: Quality prediction based on a single page's text of one particular extraction tool (PyMuPDF) is challenging.  
 
 ### 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.
+Fine-tune further on your document corpus. 
 
 ## How to Get Started with the Model
 
@@ -76,29 +52,22 @@ Use the code below to get started with the model.
 ## 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]
+~30K documents. Not public. 
 
 ### Training Procedure
-
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-
+Internal software:
+```
+run_training.py ... --parser pymupdf --max_page_idx 0 --task reg --alpha 0.5 --multi --batch_size 64 --n_epochs 12 --learn_rate 3e-5
+```
 #### Preprocessing [optional]
-
-[More Information Needed]
-
+None
 
 #### 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 -->
+- **Training regime:** fp32
 
 #### Speeds, Sizes, Times [optional]
-
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-
-[More Information Needed]
+None
 
 ## Evaluation
 
@@ -158,42 +127,31 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 ### Compute Infrastructure
 
-[More Information Needed]
-
-#### Hardware
+High-performance compute (Aurora, Polaris, Sophia, Lambda) at Argonne National Laboratory (ANL)/Argonne Leadership Computing Facility (ALCF).
 
-[More Information Needed]
-
-#### Software
-
-[More Information Needed]
-
-## Citation [optional]
+## 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]
+```
+@article{siebenschuh2025adaparse,
+  title={AdaParse: An Adaptive Parallel PDF Parsing and Resource Scaling Engine},
+  author={Siebenschuh, Carlo and Hippe, Kyle and Gokdemir, Ozan and Brace, Alexander and Khan, Arham and Hossain, Khalid and Babuji, Yadu and Chia, Nicholas and Vishwanath, Venkatram and Stevens, Rick and others},
+  journal={arXiv preprint arXiv:2505.01435},
+  year={2025}
+}
+```
 
 **APA:**
+```
+Siebenschuh, C., Hippe, K., Gokdemir, O., Brace, A., Khan, A., Hossain, K., ... & Underwood, R. (2025). AdaParse: An Adaptive Parallel PDF Parsing and Resource Scaling Engine. arXiv preprint arXiv:2505.01435.
+```
 
-[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]
+Carlo Siebenschuh
 
 ## Model Card Contact
-
-[More Information Needed]
+7shoe