updated READMe

README.md

@@ -7,6 +7,26 @@ This is the official spaCy project for the Placing the Holocaust Project. This p
 
 For this project, we are using spaCy v. 3.7.4.
 
+## Project Overview
+Studying experiences of the Holocaust should not be limited to what happened in identifiable, or familiar, named places such as camps or ghettos, cities or villages. Many of the most important events of the Holocaust occurred in unnamed places. For most, physical and temporal disorientation were a real part of what it meant to be a victim of Nazi violence. Our approach to analyzing testimony transcripts recognizes the importance of the unnamed street corner, fence, farm, or hill in both survivor testimonies and conceptualizations of Holocaust landscapes generally.
+ 
+As a part of the University of Maine’s Placing the Holocaust project, we created a taxonomy of nine place categories to capture this wide array of both unnamed and named places. We were able to train a model to annotate 977 post-war testimony transcripts from the United States Holocaust Memorial Museum (USHMM). The final outcome of the project includes creating an open access site with both a search engine of the transcripts and a mapping tool (forthcoming summer 2024). In releasing our data, we hope that others can build from our methodology to implement their own place-based approach to analyzing their corpus, Holocaust-related or not, and develop their own methods to analyzing testimony transcripts. Please share your work with us!
+
+## Labels
+
+| Category                  | Definition                                                                                                                                                                                                                                 | Examples                                                                                         |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|
+| **BUILDING**              | Includes references to physical structures and places of labor or employment like factories. Institutions such as the "Judenrat" or "Red Cross" are also included.                                                                         | school, home, house, hospital, factory, station, office, store, synagogue, barracks              |
+| **COUNTRY, CONTINENT, OR LARGER** | Mostly country names, also includes "earth," "country," and "world." Distinguished from Region and Environmental feature based on context.                                                                                                  | germany, poland, states, israel, united, country, america, england, france, russia                |
+| **LANDSCAPE FEATURE**     | Places not large enough to be a geographic or populated region but too large to be an Object, includes parts of buildings like "roof" or "chimney."                                                                                        | street, door, border, line, farm, window, streets, road, wall, field                            |
+| **ENVIRONMENTAL FEATURE** | Any named or unnamed environmental feature, including bodies of water and landforms. General references like "nature" and "water" are included.                                                                                             | woods, forest, river, mountains, ground, trees, water, tree, mountain, sea                       |
+| **INTERIOR SPACE**        | References to distinct rooms within a building, or large place features of a building like a "factory floor."                                                                                                                             | room, apartment, floor, kitchen, rooms, gas, basement, bathroom, chambers, bunker                |
+| **IMAGINARY OR OTHER**    | Difficult terms that are context-dependent like "inside," "outside," or "side." Also includes unspecified locations like "community," and conceptual places like "hell" or "heaven."                                                      | place, outside, places, side, inside, hiding, hell, heaven, part, spot                          |
+| **POPULATED PLACE**       | Includes cities, towns, villages, and hamlets or crossroads settlements. Names of places can be the same as a ghetto, camp, city, or district.                                                                                             | camp, ghetto, town, city, auschwitz, camps, new, york, concentration, village                   |
+| **REGION**                | Sub-national regions, states, provinces, or islands. Includes references to sides of a geopolitical border or military zone.                                                                                                               | area, side, land, siberia, new, zone, jersey, california, russian, eastern                      |
+| **OBJECTS**               | Objects of conveyance and movable objects like furniture. In specific contexts, refers to transportation vehicles or items like "ovens," where the common use case of the term prevails.                                                   | train, car, ship, boat, bed, truck, trains, cars, trucks                                        |
+
+
 ## 📋 project.yml
 
 The [`project.yml`](project.yml) defines the data assets required by the project, as well as the available commands and workflows. For details, see the [Weasel documentation](https://github.com/explosion/weasel).
@@ -61,7 +81,9 @@ The following assets are defined by the project. They can be fetched by running
 | [`notebooks/*`](notebooks/*) | Local | Notebooks for testing project features. |
 | [`configs/*`](configs/*) | Local | Config files for training spaCy models. |
 
-# Overall Model Performance
+## Model Metrics
+
+### Overall Model Performance
 | Model       |   Precision |   Recall |   F-Score |
 |:------------|------------:|---------:|----------:|
 | Small       |        94.1 |     89.2 |      91.6 |
@@ -69,7 +91,8 @@ The following assets are defined by the project. They can be fetched by running
 | Large       |        94.1 |     91.7 |      92.9 |
 | Transformer |        93.6 |     91.6 |      92.6 |
 
-# Performance per Label
+
+### Performance per Label
 | Model       | Label           |   Precision |   Recall |   F-Score |
 |:------------|:----------------|------------:|---------:|----------:|
 | Small       | BUILDING        |        94.7 |     90.2 |      92.4 |
@@ -107,4 +130,13 @@ The following assets are defined by the project. They can be fetched by running
 | Small       | SPATIAL_OBJ     |        96   |     90   |      92.9 |
 | Medium      | SPATIAL_OBJ     |        95.2 |     93.8 |      94.5 |
 | Large       | SPATIAL_OBJ     |        95.3 |     95.5 |      95.4 |
-| Transformer | SPATIAL_OBJ     |        96.3 |     92.8 |      94.5 |  
+| Transformer | SPATIAL_OBJ     |        96.3 |     92.8 |      94.5 |  
+
+
+## Acknowledgements
+
+This project, based in the University of Maine’s History Department (Anne Kelly Knowles, PI), has been funded by National Endowment for the Humanities Digital Humanities Advancement grant no. HAA-287827-22; a Collaborative Research Seed Grant, Center for the Humanities, Washington University in St. Louis; the Clement and Linda McGillicuddy Humanities Center, University of Maine; and the Dale Benson Gift Fund, University of Maine.
+
+## Dataset Team
+
+Christine Liu, William Mattingly, Gregory Gaines