Improve model card: Add metadata, link to paper and code, and basic description

This PR improves the model card by:

* Adding the `text-generation` pipeline tag.
* Linking to the paper.
* Linking to the GitHub repository.
* Adding License information (assumed MIT).
* Adding a brief model description.
* Adding basic usage example.
* Adding tags.

Please review and update the model card with more details as needed.

README.md

@@ -1,127 +1,110 @@
 ---
 library_name: transformers
-tags: []
+pipeline_tag: text-generation
+tags:
+  - llama
+  - text-generation
+  - causal-lm
+license: mit
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
-
-
+This model is a large language model trained using the methods described in the paper [Pretraining Language Models for Diachronic Linguistic Change Discovery](https://huggingface.co/papers/2504.05523). It can be used for text generation tasks.
 
 ## 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.
+This model is a large language model trained on a historical text corpus. Further details about the model architecture and training are available in the provided links.
 
-- **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]
+*   **Developed by:** [More Information Needed]
+*   **Funded by \[optional]:** [More Information Needed]
+*   **Shared by \[optional]:** [More Information Needed]
+*   **Model type:** Llama
+*   **Language(s) (NLP):** English
+*   **License:** MIT
+*   **Finetuned from model \[optional]:** [More Information Needed]
 
-### Model Sources [optional]
+### Model Sources \[optional]
 
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+*   **Repository:** [https://github.com/comp-int-hum/historical-perspectival-lm](https://github.com/comp-int-hum/historical-perspectival-lm)
+*   **Paper \[optional]:** [https://huggingface.co/papers/2504.05523](https://huggingface.co/papers/2504.05523)
+*   **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. -->
+The model can be used directly for text generation tasks, such as generating text in a specific historical style or completing text prompts.
 
-[More Information Needed]
-
-### Downstream Use [optional]
+### 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]
+The model could be fine-tuned for various downstream tasks such as text classification, summarization, or question answering related to historical text.
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-
-[More Information Needed]
+The model may not perform well on tasks outside of text generation and historical text analysis. Its performance on contemporary language tasks is likely to be suboptimal.
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-
-[More Information Needed]
+The model's training data consists of historical texts, which may reflect biases present in those texts. The model may generate outputs that perpetuate these biases. The model's performance will vary based on the characteristics of the input text. More information is needed for a comprehensive analysis of bias and risk.
 
 ### 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.
+Users should be aware of the potential for bias in the model's outputs and use caution when interpreting its predictions. The model should not be used for applications where biased or inaccurate outputs could have harmful consequences.
 
 ## How to Get Started with the Model
 
 Use the code below to get started with the model.
 
-[More Information Needed]
+```python
+from transformers import AutoTokenizer, AutoModelForCausalLM
+
+model_id = "your_model_id"  # Replace this with the actual model id.
+tokenizer = AutoTokenizer.from_pretrained(model_id)
+model = AutoModelForCausalLM.from_pretrained(model_id)
+
+prompt = "This is a test prompt:"
+inputs = tokenizer(prompt, return_tensors="pt")
+outputs = model.generate(**inputs)
+print(tokenizer.decode(outputs[0], skip_special_tokens=True))
+```
 
 ## 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]
+[More Information Needed, Link to Dataset Card and description]
 
 ### 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]
+#### 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]
+*   **Training regime:** [More Information Needed]
 
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
+#### Speeds, Sizes, Times \[optional]
 
 [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]
+[More Information Needed, Link to Dataset Card and description]
 
 #### 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
@@ -130,27 +113,23 @@ Use the code below to get started with the model.
 
 #### Summary
 
+[More Information Needed]
 
-
-## Model Examination [optional]
-
-<!-- Relevant interpretability work for the model goes here -->
+## Model Examination \[optional]
 
 [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]
+*   **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]
+## Technical Specifications \[optional]
 
 ### Model Architecture and Objective
 
@@ -168,29 +147,27 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Citation [optional]
+## 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. -->
+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]
+[More Information Needed, Add Bibtex for 2504.05523]
 
 **APA:**
 
-[More Information Needed]
-
-## Glossary [optional]
+[More Information Needed, Add APA for 2504.05523]
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+## Glossary \[optional]
 
 [More Information Needed]
 
-## More Information [optional]
+## More Information \[optional]
 
 [More Information Needed]
 
-## Model Card Authors [optional]
+## Model Card Authors \[optional]
 
 [More Information Needed]