Merge branch 'main' into docfeatures

.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -0,0 +1,62 @@
+# ML-Sim:
+
+Synthetic Data generators for ML  evaluation
+
+## Getting Started
+
+
+
+
+To use the package:
+
+```bash
+git clone https://github.com/ml4sts/ml-sim.git
+cd ml-sim/
+pip install .
+```
+
+To use the package, after installed:
+
+```python
+import mlsim
+```
+
+
+
+## Development
+
+To work in a separate development environment use the `requirements.txt` to install dependencies
+
+
+### To reinstall  package after changes
+
+```
+pip install --upgrade .
+```
+
+Or use
+```
+pip intall -e .
+```
+When updating the package and working in a notebook, the notebook's kernel will
+need to be restarted to get the updates, if they're done outside of the notebook.
+
+(only needed in development or after upgrade)
+
+
+
+## Offline Documentation
+To compile docs, jupyter book and some sphinx extensions are required, install
+them with
+
+```
+pip install -r requirements.txt
+```
+
+then
+
+```
+jupyter-book build docs/
+```
+
+to build the documentation offline.

mlsim/__init__.py

@@ -1,6 +1,7 @@
 
-from . import anomaly
 
-from . import base
+from . import anomaly
 
 from . import bias
+
+__all__ = ['bias','anomaly']

mlsim/bias/__init__.py

@@ -1,4 +1,4 @@
-from .populations import Population,PopulationInstantiated
+from .populations import Population, PopulationInstantiated
 from .bias_components import Demographic, DemographicIndependent, DemographicCorrelated
 from .bias_components import Target, TargetDisadvantagedError, TargetTwoError
 from .bias_components import Feature,FeatureSharedParam,FeatureTwoParams

setup.py

@@ -7,6 +7,6 @@
       author='Sarah M Brown',
       author_email='[email protected]',
       license='MIT',
-      packages=['mlsim','mlsim.bias','mlsim.anomaly'],
+      packages=['mlsim','mlsim.bias','mlsim.anomaly', 'mlsim.base'],
       zip_safe=False,
-      install_requires=['Numpy', 'Scipy'])
+      install_requires=['Numpy', 'Scipy', 'aif360', 'Pandas'])