Upload ./README.md with huggingface_hub

README.md

@@ -1,41 +1,35 @@
 ---
-license: other
-base_model: meta-llama/Meta-Llama-3-8B
-tags:
-- llama-factory
-- full
-- generated_from_trainer
-model-index:
-- name: C016_random_sample_llama3-8b-base_pretrain_20240504_181744
-  results: []
+license: cc-by-4.0
+datasets:
+- PKU-Alignment/ProgressGym-HistText
+base_model:
+- meta-llama/Meta-Llama-3-8B
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# ProgressGym-HistLlama3-8B-C016-pretrain
 
-# C016_random_sample_llama3-8b-base_pretrain_20240504_181744
+## Overview
 
-This model is a fine-tuned version of [/data/pro-align/progressalign/shared_storage/downloaded_models/llama3-8b-base](https://huggingface.co//data/pro-align/progressalign/shared_storage/downloaded_models/llama3-8b-base) on the C016_random_sample_data dataset.
-It achieves the following results on the evaluation set:
-- Loss: 2.4196
+#### The ProgressGym Framework
 
-## Model description
+![Framework Diagram](./readme-assets/main-diagram.png)
 
-More information needed
+**ProgressGym-HistLlama3-8B-C016-pretrain** is part of the **ProgressGym** framework for research and experimentation on *progress alignment* - the emulation of moral progress in AI alignment algorithms, as a measure to prevent risks of societal value lock-in. 
 
-## Intended uses & limitations
+To quote the paper [*ProgressGym: Alignment with a Millennium of Moral Progress*](https://arxiv.org/abs/2406.20087):
 
-More information needed
+> Frontier AI systems, including large language models (LLMs), hold increasing influence over the epistemology of human users. Such influence can reinforce prevailing societal values, potentially contributing to the lock-in of misguided moral beliefs and, consequently, the perpetuation of problematic moral practices on a broad scale. 
+>
+> We introduce *progress alignment* as a technical solution to mitigate this imminent risk. Progress alignment algorithms learn to emulate the mechanics of human moral progress, thereby addressing the susceptibility of existing alignment methods to contemporary moral blindspots.
 
-## Training and evaluation data
+#### ProgressGym-HistLlama3-8B-C016-pretrain
 
-More information needed
+ProgressGym-HistLlama3-8B-C016-pretrain is one of the **36 historical language models** in the ProgressGym framework. It is a pretrained model without instruction-tuning. For the instruction-tuned version, see [ProgressGym-HistLlama3-8B-C016-instruct](https://huggingface.co/PKU-Alignment/ProgressGym-HistLlama3-8B-C016-instruct).
 
-## Training procedure
+**ProgressGym-HistLlama3-8B-C016-pretrain is under continual iteration.** Improving upon the current version, new versions of the model are currently being trained to reflect historical moral tendencies in ever more comprehensive ways.
 
-### Training hyperparameters
+**ProgressGym-HistLlama3-8B-C016-pretrain is a 16th-century historical language model.** Based on [Meta-Llama-3-8B](https://huggingface.co/meta-llama/Meta-Llama-3-8B), It is continued-pretrained on the 16th-century text data from [ProgressGym-HistText](https://huggingface.co/datasets/PKU-Alignment/ProgressGym-HistText), using the following hyperparameters:
 
-The following hyperparameters were used during training:
 - learning_rate: 1.5e-05
 - train_batch_size: 8
 - eval_batch_size: 16
@@ -50,7 +44,7 @@ The following hyperparameters were used during training:
 - num_epochs: 4.0
 - mixed_precision_training: Native AMP
 
-### Training results
+... with the following training results:
 
 | Training Loss | Epoch  | Step | Validation Loss |
 |:-------------:|:------:|:----:|:---------------:|
@@ -75,10 +69,38 @@ The following hyperparameters were used during training:
 | 2.2002        | 3.7001 | 3800 | 2.4294          |
 | 2.2437        | 3.8948 | 4000 | 2.4291          |
 
-
-### Framework versions
-
-- Transformers 4.40.1
-- Pytorch 2.3.0
-- Datasets 2.19.0
-- Tokenizers 0.19.1
+Note that the training data volume for the continued pretraining stage is capped at 300MB. When the corresponding century's corpus exceeds this volume, the training data is randomly sampled to fit the volume.
+
+## Links
+
+- **[Paper Preprint]**  [ProgressGym: Alignment with a Millennium of Moral Progress](https://arxiv.org/abs/2406.20087)
+- **[Leaderboard & Interactive Playground]** PKU-Alignment/ProgressGym-LeaderBoard *(coming soon)*
+- **[Github Codebase]** PKU-Alignment/ProgressGym *(coming soon)*
+- **[Huggingface Data & Model Collection]** [PKU-Alignment/ProgressGym](https://huggingface.co/collections/PKU-Alignment/progressgym-666735fcf3e4efa276226eaa)
+- **[PyPI Package]** *(coming soon)*
+
+## Citation
+
+If the datasets, models, or framework of ProgressGym help you in your project, please cite ProgressGym using the bibtex entry below.
+
+```text
+@article{progressgym,
+  title={ProgressGym: Alignment with a Millennium of Moral Progress},
+  author={Tianyi Qiu and Yang Zhang and Xuchuan Huang and Jasmine Xinze Li and Jiaming Ji and Yaodong Yang},
+  journal={arXiv preprint arXiv:2406.20087},
+  eprint={2406.20087},
+  eprinttype = {arXiv},
+  year={2024}
+}
+```
+
+## Ethics Statement
+
+- **Copyright information of historical text data sources**:
+  - Project Gutenberg, one among our four source of our historical text data, consists only of texts in the public domain.
+  - For the text that we draw from Internet Archive, we only include those that uploaded by *Library of Congress*, which are texts freely released online by the U.S. Library of Congress for research and public use.
+  - The text data from Early English Books Online are, according to their publisher, "freely available to the public" and "available for access, distribution, use, or reuse by anyone".
+  - The last remaining source of our historical text data, the Pile of Law dataset, is released under a Creative Commons license, which we adhere to in our use.
+- **Reproducibility**: To ensure reproducibility, we open-source all the code involved in the production of our main results (including the entire pipeline starting from data collection and model training), as well as the supporting infrastructure (the ProgressGym framework), making replication as easy as running a few simple script files.
+- **Misuse Prevention**: In order to prevent potential misuse of progress alignment algorithms, we have carefully formulated progress alignment as strictly value-neutral, without *a priori* assumptions on the direction of progress. In the event of potential misuse of our dataset, we condemn any misuse attempt to the strongest degree possible, and will work with the research community on whistleblowing for such attempts. 
+- **Open-Sourcing**: We confirm that our code, data, and models are to be open-sourced under a CC-BY 4.0 license. We will continue to maintain and update our open-source repositories and models.