Update README.md

README.md

@@ -1,3 +1,72 @@
----
-license: cc-by-sa-4.0
----
+---
+license: cc-by-sa-4.0
+language:
+- en
+base_model:
+- patcdaniel/phytoClassUCSC
+---
+
+_This model and readme file are derivative of the [phytoClassUCSC](https://huggingface.co/patcdaniel/phytoClassUCSC) classifier._
+
+## Model details
+
+- A modified version of the [phytoClassUCSC](https://huggingface.co/patcdaniel/phytoClassUCSC) classifier, made to run on modern () tensorflow versions.
+- Originally eveloped by the Kudela Lab from the Ocean Sciences Department at University of California, Santa Cruz.
+- Current version trained in February, 2023.
+- depthwise-CNN based on the Xception architecture [Chollet, F., 2017](https://arxiv.org/abs/1610.02357) with 134 layers using weights pretrained on ImageNet.
+- An average pooling layer is used.
+- Licensed under CC-BY-SA-4.0
+- For questions on the original model email Patrick Daniel <[pcdaniel@ucsc.edu](pcdaniel@ucsc.edu)>
+- For questions on the adaptions made to update the model email Alex Baldwin <[alewin@noc.ac.uk](alewin@noc.ac.uk)>
+
+## Intended use
+
+This model was designed and trained to work with IFCB data generated in Monterey Bay. While that does not mean it may not perform well in other locations, the distribution of training images reflects common phytoplankton observed at the Santa Cruz Wharf and Power Buoy locations. Independent model validation should be used when applying the model to other sites.
+
+### Primary intended uses
+
+Generalized micro-phytoplankton classifier for common taxa found in the Monterey Bay.
+
+### Primary intended users
+
+Researchers intersted in a general.
+
+### Out-of-scope use cases
+
+Observing and identifying rare or non-endemic taxa.
+
+## Factors
+
+Model classes were chosen based on common and resolvable phytoplankton taxa. Taxonomic groupings were chosen based on what researchers in the lab felt groups that could be confidently identified, given the expertise and research intersts of the lab.
+
+### Instrument
+
+Model was trained on images from Imaging FlowCytobot (IFCB) instruments primary deployed at the Santa Cruz Wharf and the Monterey Bay Aquarium Research Institute (MBARI) Power Buoy. The Santa Cruz Wharf IFCB (#104) is an early generation 
+
+## Metrics
+
+Deployed model performance will vary with the natural variabilability in the observed phytoplankton communities over different time scales (seasonality). As such model performance should be evaluated throughout IFCb deployments using independently labled images.
+
+### Model performance measures
+
+Training model performace was evaluated using a held-back validation training set. F1-scores were calcuated for each class. [See Results here](https://stage-habdac-streamlit.srv.axds.co/Model_Metrics)
+
+### Approaches to uncertainty and variability
+
+Uncertainty is addressed by applying a set of class-specific thresholds for each prediction. This works reasonably well for out-of-distribution images.
+
+## Training data
+
+To Be Described
+
+## Ethical considerations
+
+None
+
+## Caveats and recommendations
+
+This model was developed as in interation of previous classification efforts and as such is subject to a history of decision making that is not captured here. For that reasons this classifier is not a panacea for all phytoplankton image data, but was specifically developed for looking at phytoplankton communities in Monterey Bay.
+
+IFCB collected data are very context specific and subject to both observation configurations and small-scale variability. 
+
+Review section 4.9 of the [model cards paper](https://arxiv.org/abs/1810.03993).