"Added some documentation for what the huggingface directory is for"

huggingface/README.md

@@ -0,0 +1,5 @@
+This directory is to maintain the 🤗 support of METL.
+
+Herein are a few files to facilitate uploading the wrapper to 🤗. First, combine_files.py takes all of the files in the METL directory, barring files that have test or _.py (think, innit.py here) and combines them into a single file. combine_files.py also appends the huggingface wrapper code itself (stored in huggingface_code.py) onto the bottom of the script.
+
+This script then gets auto-updated to 🤗 after formatting it by running the push_to_hub.py script. Some additional small comments are included in the top of each file repeating these responsibilities.

huggingface/combine_files.py

@@ -1,3 +1,11 @@
+"""
+This script combines all of the files in the metl directory into one file so that it can be uploaded automatically to huggingface.
+
+Files ending with _.py and that contain test in the filename will not be included. This script automatically generates the required imports from the files as well.
+
+Regardless of changes to metl, as long as necessary files that may be added don't contain test or _.py, this should work as intended.
+"""
+
 import argparse
 import os
 

huggingface/huggingface_code.py

@@ -1,3 +1,10 @@
+"""
+This file contains the actual wrapper for METL. 
+Above the delimiter for this file: #$> we have included imports and shell functions 
+which prevent python (and other linters) from complaining this file has erros. 
+"""
+
+
 from transformers import PretrainedConfig, PreTrainedModel
 
 def get_from_uuid():

huggingface/huggingface_wrapper.py

@@ -1,3 +1,7 @@
+"""
+This is an example wrapper after running the script combine_files. This is NOT the version on huggingface. That gets compiled live after ever PR or push to main.
+"""
+
 import collections
 import copy
 import enum

huggingface/print_colab_dropdown.py

@@ -1,3 +1,9 @@
+"""
+Utility script for generating a list that can be pasted into the google colab when more models are uploaded to zenodo and added to the METL IDENT_UUID_MAP.
+
+This pulls from huggingface, so wait for that action to finish first before running this script and uploading the colab notebook.
+"""
+
 from transformers import AutoModel
 
 def main():

huggingface/push_to_hub.py

@@ -1,3 +1,8 @@
+"""
+Basic minimal script for uploading the generated file from combine_files.py onto huggingface. 
+Requires the action to have access to the HF_TOKEN secret. 
+"""
+
 from huggingface_wrapper import METLConfig, METLModel
 from huggingface_hub import login
 import os