Upload README.md with huggingface_hub

README.md

@@ -1,199 +1,180 @@
----
-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. -->
+This is an *unofficial* reupload of [CAUKiel/JavaBERT](https://huggingface.co/CAUKiel/JavaBERT) in the `SafeTensors` format using `transformers` `4.40.1`. The goal of this reupload is to prevent older models that are still relevant baselines from becoming stale as a result of changes in HuggingFace. Additionally, I may include minor corrections, such as model max length configuration.
+---
+language:
+- code
+license: apache-2.0
+widget:
+- text: public [MASK] isOdd(Integer num) {if (num % 2 == 0) {return "even";} else
+    {return "odd";}}
+---
 
+# Model Card for JavaBERT
+ 
+A BERT-like model pretrained on Java software code.
+ 
+ 
+ 
+ 
+ 
+ 
+# Model Details
+ 
+## Model Description
+ 
+A BERT-like model pretrained on Java software code.
+ 
+- **Developed by:** Christian-Albrechts-University of Kiel (CAUKiel)
+- **Shared by [Optional]:** Hugging Face
+- **Model type:** Fill-Mask
+- **Language(s) (NLP):** en
+- **License:** Apache-2.0
+- **Related Models:** A version of this model using an uncased tokenizer is available at [CAUKiel/JavaBERT-uncased](https://huggingface.co/CAUKiel/JavaBERT-uncased).
+  - **Parent Model:** BERT
+- **Resources for more information:** 
+  - [Associated Paper](https://arxiv.org/pdf/2110.10404.pdf)
+ 
+ 
+# Uses
+ 
+## Direct Use
+ 
+Fill-Mask
+ 
+## Downstream Use [Optional]
+ 
+More information needed.
+ 
+## Out-of-Scope Use
+ 
+The model should not be used to intentionally create hostile or alienating environments for people. 
+ 
+# Bias, Risks, and 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
+ 
 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 -->
-
+{ see paper= word something)
+ 
+# Training Details
+ 
+## Training Data
+The model was trained on 2,998,345 Java files retrieved from open source projects on GitHub. A ```bert-base-cased``` tokenizer is used by this model.
+ 
+## Training Procedure
+ 
+ 
+### Training Objective
+A MLM (Masked Language Model) objective was used to train this model.
+ 
+### Preprocessing
+ 
+More information needed.
+ 
+ 
+### Speeds, Sizes, Times
+ 
+More information needed.
+ 
+# Evaluation
+ 
+ 
+ 
+## Testing Data, Factors & Metrics
+ 
+### Testing Data
+More information needed.
+ 
+ 
+### Factors
+ 
+
+ 
+### Metrics
+ 
+More information needed.
+ 
+ 
+## Results 
+More information needed.
+ 
+ 
+# Model Examination
+ 
+More information needed.
+ 
+# Environmental Impact
+ 
+ 
 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. -->
-
+ 
+- **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
+ 
+ 
+ 
 **BibTeX:**
-
-[More Information Needed]
-
+ 
+More information needed.
+ 
 **APA:**
+ 
+More information needed.
+ 
+# Glossary [optional]
+More information needed.
+ 
+# More Information [optional]
+ 
+More information needed.
+ 
+# Model Card Authors [optional]
+ 
+Christian-Albrechts-University of Kiel (CAUKiel)  in collaboration with Ezi Ozoani and the team at Hugging Face
+ 
+# 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>
+
+ ```python
+from transformers import pipeline
+pipe = pipeline('fill-mask', model='CAUKiel/JavaBERT')
+output = pipe(CODE) # Replace with Java code; Use '[MASK]' to mask tokens/words in the code.
+```
+ 
+</details>
 
-[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]