Update README.md

README.md

@@ -1,3 +1,148 @@
----
-license: cc0-1.0
----
+---
+license: cc0-1.0
+language:
+- en
+pretty_name: The Metropolitan Museum of Art - Open Access CSV
+dataset_info:
+  features:
+    - name: Object Number
+      dtype: string
+    - name: Is Highlight
+      dtype: bool
+    - name: Is Timeline Work
+      dtype: bool
+    - name: Is Public Domain
+      dtype: bool
+    - name: Object ID
+      dtype: int32
+    - name: Gallery Number
+      dtype: string
+    - name: Department
+      dtype: string
+    - name: AccessionYear
+      dtype: float64
+    - name: Object Name
+      dtype: string
+    - name: Title
+      dtype: string
+    - name: Culture
+      dtype: string
+    - name: Period
+      dtype: string
+    - name: Dynasty
+      dtype: string
+    - name: Reign
+      dtype: string
+    - name: Portfolio
+      dtype: string
+    - name: Constituent ID
+      dtype: string
+    - name: Artist Role
+      dtype: string
+    - name: Artist Prefix
+      dtype: string
+    - name: Artist Display Name
+      dtype: string
+    - name: Artist Display Bio
+      dtype: string
+    - name: Artist Suffix
+      dtype: string
+    - name: Artist Alpha Sort
+      dtype: string
+    - name: Artist Nationality
+      dtype: string
+    - name: Artist Begin Date
+      dtype: string
+    - name: Artist End Date
+      dtype: string
+    - name: Artist Gender
+      dtype: string
+    - name: Artist ULAN URL
+      dtype: string
+    - name: Artist Wikidata URL
+      dtype: string
+    - name: Object Date
+      dtype: string
+    - name: Object Begin Date
+      dtype: int64
+    - name: Object End Date
+      dtype: int64
+    - name: Medium
+      dtype: string
+    - name: Dimensions
+      dtype: string
+    - name: Credit Line
+      dtype: string
+    - name: Geography Type
+      dtype: string
+    - name: City
+      dtype: string
+    - name: State
+      dtype: string
+    - name: County
+      dtype: string
+    - name: Country
+      dtype: string
+    - name: Region
+      dtype: string
+    - name: Subregion
+      dtype: string
+    - name: Locale
+      dtype: string
+    - name: Locus
+      dtype: string
+    - name: Excavation
+      dtype: string
+    - name: River
+      dtype: string
+    - name: Classification
+      dtype: string
+    - name: Rights and Reproduction
+      dtype: string
+    - name: Link Resource
+      dtype: string
+    - name: Object Wikidata URL
+      dtype: string
+    - name: Metadata Date
+      dtype: string
+    - name: Repository
+      dtype: string
+    - name: Tags
+      dtype: string
+    - name: Tags AAT URL
+      dtype: string
+    - name: Tags Wikidata URL
+      dtype: string
+---
+The Metropolitan Museum of Art Open Access on HuggingFace
+===================
+
+The [Metropolitan Museum of Art](http://www.metmuseum.org) presents over 5,000 years of art from around the world for everyone to experience and enjoy. The Museum lives in two iconic sites in New York City-The Met Fifth Avenue and The Met Cloisters. Millions of people also take part in The Met experience online.
+
+Since it was founded in 1870, The Met has always aspired to be more than a treasury of rare and beautiful objects. Every day, art comes alive in the Museum's galleries and through its exhibitions and events, revealing both new ideas and unexpected connections across time and across cultures.
+
+The Metropolitan Museum of Art provides select datasets of information on more than 470,000 artworks in its Collection for unrestricted commercial and noncommercial use. To the extent possible under law, The Metropolitan Museum of Art has waived all copyright and related or neighboring rights to this dataset using [Creative Commons Zero](https://creativecommons.org/publicdomain/zero/1.0/). This work is published from: The United States Of America. You can also find the text of the CC Zero deed in the file [LICENSE](https://github.com/metmuseum/openaccess/blob/master/LICENSE) in this repository. These select datasets are now available for use in any media without permission or fee; they also include identifying data for artworks under copyright. The datasets support the search, use, and interaction with the Museum's collection. 
+
+## Additional usage guidelines
+For more details on how to use images of artworks in The Metropolitan Museum of Art’s collection, please visit our [Open Access](http://www.metmuseum.org/about-the-met/policies-and-documents/image-resources) page.
+
+## Updating or recreating the CSV + images
+Right now, this is a manual process. Working on it!
+1. Download or clone the CSV from our [github](https://github.com/metmuseum/openaccess)
+2. (Optional) Create a compressed CSV
+    * Since some operating systems or machines choke on our huge CSV, it can be convenient to compress the file. 
+    * Easiest: ```gzip MetObjects.csv```
+3. Process the CSV
+    * Right now, there are many ```\n``` characters in the CSV. Some Python interpreters don't like this. 
+    * Use ```clean.py``` to create a cleaned version, now called ```metadata.csv.gz```
+4. (Optional) add images to the CSV
+    * Run ```add_images.py```
+    * It will take a while
+    * CAUTION: be very careful with the ```do_verify``` variable. Some networks do SSL redirects that Python does not like. Disabling this will not verify SSL certs. This is a quick band-aid to bypass this, but totally unsafe.
+5. Install [img2dataset](https://github.com/rom1504/img2dataset)
+    * ```pip install img2dataset```
+6. Run ```img2dataset``` with the following options:
+    * ```img2dataset --processes_count 10 --thread_count 64 --url_list "cleaned_metadata_images.csv.gz" --input_format "csv.gz" --output_format "webdataset" --output_folder "data" --url_col "primaryImageSmall" --disable_all_reencoding "True" --max_shard_retry 10 --retries 10 --save_additional_columns "['Is Highlight', 'Is Timeline Work', 'Is Public Domain', 'Object ID', 'Gallery Number', 'Department', 'AccessionYear', 'Object Name', 'Title', 'Culture', 'Period', 'Dynasty', 'Reign', 'Portfolio', 'Constituent ID', 'Artist Role', 'Artist Prefix', 'Artist Display Name', 'Artist Display Bio', 'Artist Suffix', 'Artist Alpha Sort', 'Artist Nationality', 'Artist Begin Date', 'Artist End Date', 'Artist Gender', 'Artist ULAN URL', 'Artist Wikidata URL', 'Object Date', 'Object Begin Date', 'Object End Date', 'Medium', 'Dimensions', 'Credit Line', 'Geography Type', 'City', 'State', 'County', 'Country', 'Region', 'Subregion', 'Locale', 'Locus', 'Excavation', 'River', 'Classification', 'Rights and Reproduction', 'Link Resource', 'Object Wikidata URL', 'Metadata Date', 'Repository', 'Tags', 'Tags AAT URL', 'Tags Wikidata URL']"```
+    * See img2dataset's docs for details on the above. You may want to remove the ```disable_all_reencoding``` option... As-is, it does not downsize or compress images at all
+    * This will take some time
+7. Voila! You should have a large data folder with many json, tar, and parquet files. You should be able to load this in the huggingface client library as a dataset, etc.