updt readme

agporto · Jul 11, 2024 · b843d56 · b843d56
1 parent c16e118
commit b843d56
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.3.1
+- bugfix: export agumentations
+- improved CLI inference script (better performance: model gets cached)
+- better documentation in the repo and the config files
+
 ## 0.3.0
 - added inference script: extract embeddings from single image
 - added parameter to show samples of image augmentations, and an argument to do a training dry run

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 # BioEncoder
 
-BioEncoder is an toolkit that leverages supervised metric learning to i) learn features from images, ii) enhance biological image classification, annd iii) identify the feature most relevant to classification. Designed for diverse and complex datasets, the package and the available metric losses can handles unbalanced classes and subtle phenotypic differences more effectively than non-metric approaches. The package includes data loaders, custom augmentation techniques, hyperparameter tuning through YAML configuration files, and rich model visualizations, providing a comprehensive solution for high-throughput analysis of biological images.
+BioEncoder is a toolkit for supervised metric learning to i) learn and extract features from images, ii) enhance biological image classification, and iii) identify the features most relevant to classification. Designed for diverse and complex datasets, the package and the available metric losses can handle unbalanced classes and subtle phenotypic differences more effectively than non-metric approaches. The package includes taxon-agnostic data loaders, custom augmentation techniques, hyperparameter tuning through YAML configuration files, and rich model visualizations, providing a comprehensive solution for high-throughput analysis of biological images.
 
 Preprint on BioRxiv: [https://doi.org/10.1101/2024.04.03.587987]( https://doi.org/10.1101/2024.04.03.587987)
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -13,7 +13,7 @@ readme = "README.md"
 requires-python = "==3.9.*"
 keywords = ["metric learning", "biology"]
 dynamic = ["dependencies"]
-version = "0.3.0"
+version = "0.3.1"
 
 [project.urls]
 "Homepage" = "https://github.com/agporto/BioEncoder"