Create README.md

README.md

@@ -0,0 +1,31 @@
+---
+license: mit
+language:
+- en
+---
+# Mixtec Labeled Dataset
+
+- [Introduction](#introduction)
+- [A Look at Figure Segments](#a-look-at-figure-segments)
+  - [File Formats and Figure Names](#file-formats-and-figure-names)
+
+# Introduction
+This dataset contains 3 different directories, `figure-cutouts/`, `name-date-cutouts/`, and `scene-cutouts/`. Each directory contains images taken from the [Mixtec Codex Zouche-Nuttall](https://en.wikipedia.org/wiki/Codex_Zouche-Nuttall). The folders comprise images of human Mixtec figures.
+
+The images in all 3 of the directories discussed above are taken from the [UF Data Studio](https://ufdatastudio.com/) Zouche-Nuttall Codex, Selden, and Vindobonensis Mexicanus I samples. Images of the orignal codex were provided as a PDF to the UF Data Studio by the [British Museum](https://www.britishmuseum.org/). To learn more about the Mixtec, read the blog post [here](https://ufdatastudio.com/posts/2023-08-29-mixtec-blog/). In addition to covering the Semasiographic Writing System of the Mixtec civilization, the post contains more general information about who the Mixtec were, as well as their contributions.
+
+# A Look at Figure Segments
+ Figure segments can all be found in the `figure-cutouts/` directory. These images of human Mixtec figures were extracted from pages of the Codex Zouche-Nuttall using [Segment Anything](https://segment-anything.com/) by Meta AI.
+
+## File Formats and Figure Names
+Below is an example of a human figure taken from the Codex.
+
+![Example of a Mixtec human figure taken from the Codex Zouche-Nuttall](assets/human.png)
+
+*Example 1 - A Human Figure Taken from the Codex Nuttall*
+
+With in the `figure-cutouts/` directory, this file is name `086-a-004.png`. The numerical values in the naming convention for each of the files denote `pageNumber-figureQuality-figureNumber`. The first field, `pageNumber`, indicates on which page in the Codex the figure was extracted from or where it can be found when referecing the full document. 
+
+The `figureQuality` field is used as a marker of quality for the extracted image. In this convention, images can be a, b, or c with a being a high quality image and c being an image that is not easy to pick out. A thorough explanation for how the quality marker was assessed can be found on the README file in this [GitHub repository](https://github.com/ufdatastudio/mixteclabeling). 
+
+The `figureNumber` field indicates what number in chronological order the figure is on the page from which it was extracted using conventions for reading a Mixtec Codex. These conventions are discussed in detail in [The Complete Codex Zouche-Nuttall: Mixtec Lineage Histories and Political Biographies](https://www.amazon.com/Complete-Codex-Zouche-Nuttall-Biographies-Pre-Columbian/dp/0292744382/?_encoding=UTF8&pd_rd_w=M3FzI&content-id=amzn1.sym.cf86ec3a-68a6-43e9-8115-04171136930a&pf_rd_p=cf86ec3a-68a6-43e9-8115-04171136930a&pf_rd_r=147-6630463-6319458&pd_rd_wg=BOkva&pd_rd_r=db400bc0-8cee-4760-88c8-0e56d9515c6f&ref_=aufs_ap_sc_dsk) by Robert Lloyd Williams.