added outline for website

centre-for-humanities-computing · Oct 23, 2023 · 49f767c · 49f767c
1 parent 7604a23
commit 49f767c
Show file tree

Hide file tree

Showing 11 changed files with 92 additions and 4 deletions.
diff --git a/docs/_static/icon.png b/docs/_static/icon.png
diff --git a/docs/datasheets/danews.md b/docs/datasheets/danews.md
@@ -232,7 +232,8 @@ writing style which is unlikely to reflect the Danish language as a whole.
 
 **Will the dataset be distributed to third parties outside of the entity (e.g., company, institution, organization) on behalf of which the dataset was created?**
 
-Data will only be available at the entity during the project. After the project the data will be archived for a period of five years to comply with the university [policy] for research integrity. After the five years, the data will be registered at the national archives as required by [executive order 514](https://www.retsinformation.dk/eli/lta/2020/514) for potential long-term deposit.
+Data will only be available at the entity during the project. If you wish access to the dataset you will have to come to an agreement with the individuals
+Danish newspapers potentially through Infomedia.
 
 ### Citation
 

diff --git a/docs/datasheets/daradio.md b/docs/datasheets/daradio.md
@@ -114,7 +114,7 @@ This dataset is static and does not evolve over time with the language, thus wil
 
 **Will the dataset be distributed to third parties outside of the entity (e.g., company, institution, organization) on behalf of which the dataset was created?**
 
-Data will only be available at the entity during the project. After the project the data will be archived for a period of five years to comply with the university [policy] for research integrity. After the five years, the data will be registered at the national archives as required by [executive order 514](https://www.retsinformation.dk/eli/lta/2020/514) for potential long-term deposit.
+Data will only be available at the entity during the project. An equivalent or updated dataset can be requested at the Royal Danish Library.
 
 
 ### Citation

diff --git a/docs/datasheets/Netarkivet_text.md → docs/datasheets/netarkivet_text.md b/docs/datasheets/Netarkivet_text.md → docs/datasheets/netarkivet_text.md
@@ -192,7 +192,7 @@ dataset going forward.
 
 **Will the dataset be distributed to third parties outside of the entity (e.g., company, institution, organization) on behalf of which the dataset was created?**
 
-Data will only be available at the entity during the project. After the project the data will be archived for a period of five years to comply with the university [policy] for research integrity. After the five years, the data will be registered at the national archives as required by [executive order 514](https://www.retsinformation.dk/eli/lta/2020/514) for potential long-term deposit.
+Data will only be available at the entity during the project. An equivalent or updated dataset can be requested at the Royal Danish Library.
 
 ### Citation
 If you wish to cite this work please see our GitHub page for an up to date citation: https://github.com/centre-for-humanities-computing/danish-foundation-models

diff --git a/docs/dcc.md b/docs/dcc.md
@@ -0,0 +1,4 @@
+# DCC <sub>v1</sub>
+
+The DCC is a composite corpus consisting of the following subcorpora.
+
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,2 @@
+
+This website is under construction 🛠️
diff --git a/docs/models_speech.md b/docs/models_speech.md
@@ -0,0 +1,6 @@
+This section contain references to models trained on speech
+
+| Model                                                                               | Model type                   |
+| ----------------------------------------------------------------------------------- | ---------------------------- |
+| [xls-r-300m-danish-nst-cv9](https://huggingface.co/chcaa/xls-r-300m-danish-nst-cv9) | Automatic speech recognition |
+| [chcaa/xls-r-300m-nst-cv9-da](https://huggingface.co/chcaa/xls-r-300m-nst-cv9-da)   | Automatic speech recognition |
diff --git a/docs/models_text.md b/docs/models_text.md
@@ -0,0 +1,9 @@
+This section contain references to models trained on text
+
+
+| Model                                                                       | Model type | Size (parameters) |
+| --------------------------------------------------------------------------- | ---------- | ----------------- |
+| [dfm-encoder-large-v1](https://huggingface.co/chcaa/dfm-encoder-large-v1)   | Encoder    | large (355M)      |
+| [dfm-encoder-medium-v1](https://huggingface.co/chcaa/dfm-encoder-medium-v1) | Encoder    | medium (110M)     |
+| [dfm-encoder-small-v1](https://huggingface.co/chcaa/dfm-encoder-small-v1)   | Encoder    | small (22M)       |
+
diff --git a/makefile b/makefile
@@ -18,4 +18,7 @@ validate: ## Run all checks
 
 pr: ## Run relevant tests before PR
 	make validate
-	gh pr create -w
+	gh pr create -w
+
+docs:
+	mkdocs serve
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,58 @@
+site_name: Danish Foundation Models
+docs_dir: "docs/"
+repo_url: https://github.com/centre-for-humanities-computing/danish-foundation-models
+watch: [docs/]
+theme:
+  name: material
+  favicon: _static/icon.png
+  logo: _static/icon.png
+  features:
+    - navigation.tracking
+    - navigation.tabs
+    - navigation.sections
+    - toc.integrate
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - content.tabs.link
+    - content.tooltips
+    - navigation.footer
+    - navigation.indexes
+    - toc.follow
+    - pymdownx.caret
+    - pymdownx.tilde
+  palette:
+    primary: white
+    accent: light blue
+    # automatic dark mode is
+
+markdown_extensions:
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - toc:
+      permalink: true
+
+copyright: Copyright &copy; 2023 Danish Foundation Models Project
+
+nav:
+  - About: index.md
+  - Models: 
+    - Text: models_text.md
+    - Speech: models_speech.md
+  - Datasets: 
+    - DCC: dcc.md
+    - Datasheets:
+      - DaNews: datasheets/danews.md
+      - HopeTwitter: datasheets/hopetwitter.md
+      - NAT: datasheets/netarkivet_text.md
+      - DaRadio: datasheets/daradio.md
+
+plugins:
+  - mkdocs-jupyter
+  - search
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/centre-for-humanities-computing/danish-foundation-models
diff --git a/pyproject.toml b/pyproject.toml
@@ -20,6 +20,11 @@ dependencies = ["pydantic==1.8.2"]
 
 [project.optional-dependencies]
 dev = ["black==23.9.1", "ruff==0.1.0", "pyright==1.1.331", "pre-commit==3.5.0"]
+docs = [
+  "mkdocs-jupyter==0.24.2",
+  "mkdocs-material==9.1.21",
+  "mkdocstrings[python]==0.22.0",
+]
 test = ["pytest==6.2.5", "pytest-lazy-fixture==0.6.3", "pytest-cov==2.8.1"]
 
 [project.license]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,4 @@
		# DCC <sub>v1</sub>

		The DCC is a composite corpus consisting of the following subcorpora.