[prep] v0.3.0 release (#28)

* be specific with pandas import

* update version number; bump synapseclient version

* update changelog

Author: vpchung

cnb_tools/validation_toolkit.py

@@ -1,8 +1,8 @@
-import pandas as pd
+from pandas import Series
 
 
 def check_missing_keys(
-    gold_col: pd.Series, pred_col: pd.Series, verbose: bool = False
+    gold_col: Series, pred_col: Series, verbose: bool = False
 ) -> str:
     """Check for missing keys.
 
@@ -29,7 +29,7 @@ def check_missing_keys(
 
 
 def check_unknown_keys(
-    gold_col: pd.Series, pred_col: pd.Series, verbose: bool = False
+    gold_col: Series, pred_col: Series, verbose: bool = False
 ) -> str:
     """Check for unknown keys.
 
@@ -55,7 +55,7 @@ def check_unknown_keys(
     return error
 
 
-def check_duplicate_keys(pred_col: pd.Series, verbose: bool = False) -> str:
+def check_duplicate_keys(pred_col: Series, verbose: bool = False) -> str:
     """Check for duplicate keys.
 
     Tip: Example Use Case
@@ -79,7 +79,7 @@ def check_duplicate_keys(pred_col: pd.Series, verbose: bool = False) -> str:
     return error
 
 
-def check_nan_values(pred_col: pd.Series) -> str:
+def check_nan_values(pred_col: Series) -> str:
     """Check for NAN values.
 
     Tip: Example Use Case
@@ -99,7 +99,7 @@ def check_nan_values(pred_col: pd.Series) -> str:
 
 
 def check_binary_values(
-    pred_col: pd.Series, label1: int = 0, label2: int = 1
+    pred_col: Series, label1: int = 0, label2: int = 1
 ) -> str:
     """Check that values are binary (default: 0 or 1).
 
@@ -122,7 +122,7 @@ def check_binary_values(
 
 # pylint: disable=unsupported-binary-operation
 def check_values_range(
-    pred_col: pd.Series, min_val: int | float = 0, max_val: int | float = 1
+    pred_col: Series, min_val: int | float = 0, max_val: int | float = 1
 ) -> str:
     """Check that values are between min and max values, inclusive.
 

docs/changelog/release-notes.md

@@ -3,6 +3,20 @@
 ### Features
 - Add new CLI command: `cnb-tools challenge SUBCOMMAND`
 
+### Docs
+- Add How-To tutorial on how the Validation Toolkit can be used
+
+### Bug fixes
+- Remove custom classes, as to prevent future confusion with synapseclient's classes
+
+## 0.3.0
+
+### Features
+- Add new module: validation_toolkit ([#26](https://github.com/Sage-Bionetworks-Challenges/cnb-tools/pull/26))
+
+### Bug fixes
+- Handle use case when there is one or more unknown submission IDs in given list ([#23](https://github.com/Sage-Bionetworks-Challenges/cnb-tools/pull/23))
+
 ## 0.2.0
 
 ### Features