diff --git a/README.rst b/README.rst index 695968f5b05c11574b6a2fdddf116a246373691c..faf1176cdc5d18b03d5c3ff690fdcab964572c05 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,33 @@ -WIP Multiview Generator -======================== +.. |pipeline| image:: https://gitlab.lis-lab.fr/dev/multiview_generator/badges/master/pipeline.svg + :alt: Pipeline status + +.. |license| image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg + :target: https://opensource.org/licenses/BSD-3-Clause + :alt: License: New BSD + +.. |coverage| image:: https://gitlab.lis-lab.fr/dev/multiview_generator/badges/master/coverage.svg + :target: http://dev.pages.lis-lab.fr/multiview_generator/coverage/index.html + :alt: Coverage + +|pipeline| |license| |coverage| + +Multiview Generator +=================== + +This package aims at generating customized mutliview datasets to facilitate the +development of new multiview algorithms and their testing on simulated data +representing specific tasks. + +Understanding the concept +------------------------- + +The main idea of the generator is to build several monoview sub-problems that + + +.. image:: _static/fig_rec.png + :width: 100% + :align: center -This package aims at generating mutliview datasets according to multipe paramterers : -an error matrix, that tracks the error of each view on each class, a redundancy float that controls the ration of examples that are well described by all the viewsw, -similarly the lutual error float controls the one that are misdescribed in eavery views. Structure --------- diff --git a/_static/fig_rec.png b/_static/fig_rec.png new file mode 100644 index 0000000000000000000000000000000000000000..8b1dde52ecc5797568e18ec7dd5efe9ddb01a54e Binary files /dev/null and b/_static/fig_rec.png differ diff --git a/demo/config_demo.yml b/demo/config_demo.yml index fabaeecad0b73906823b950b53ac033111c32e59..fdfeea36f1201f26cd71a2dfc50fc037b6e932e9 100644 --- a/demo/config_demo.yml +++ b/demo/config_demo.yml @@ -9,7 +9,7 @@ n_features: 3 n_informative: 3 class_seps: 10 class_weights: [0.125, 0.125, 0.125,]# 0.125, 0.125, 0.125, 0.125, 0.125,] -mutual_error: [0.4, 0.4,0.4] +mutual_error: [0.2, 0.2,0.2] redundancy: [0.5,0.4,0.4] complementarity: [0.1, 0.05,0.05] name: "demo" diff --git a/docs/source/index.rst b/docs/source/index.rst index 27c6fb9815d54f0111b82ae466c0200253d0ae72..66f95ecc1068423e8711a99432bc1f690682aac8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,6 +24,11 @@ To install SMuDGE, clone the gitlab repository and run include_tuto3 documentation +Read me +========= + +.. include:: readme_link.rst + Indices and tables ================== diff --git a/docs/source/readme_link.rst b/docs/source/readme_link.rst new file mode 100644 index 0000000000000000000000000000000000000000..38ba8043dfafb6e6eb527e5c18db3195090b8007 --- /dev/null +++ b/docs/source/readme_link.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst \ No newline at end of file diff --git a/multiview_generator/__init__.py b/multiview_generator/__init__.py index a1404fc476cff843dde053ca2ea8a8272e84f88f..e851e58bf4c7b631d2a67f501bb74c7a2b0a8217 100644 --- a/multiview_generator/__init__.py +++ b/multiview_generator/__init__.py @@ -1 +1 @@ -__version__ = '1.0.dev0' +__version__ = "0.0.dev0" diff --git a/multiview_generator/multiple_sub_problems.py b/multiview_generator/multiple_sub_problems.py index 895d24a5baab3ef9d5bfc17cbfe4cafd44f5e362..553372eef119ed49110b7a66a8b9e0c81d95f59d 100644 --- a/multiview_generator/multiple_sub_problems.py +++ b/multiview_generator/multiple_sub_problems.py @@ -159,7 +159,7 @@ class MultiViewSubProblemsGenerator: self.gen_report(save=False) meta_data_grp.attrs["description"] = self.report - meta_data_grp.create_dataset("example_ids", data=np.array( + meta_data_grp.create_dataset("sample_ids", data=np.array( self.example_ids).astype( np.dtype("S100")), dtype=np.dtype("S100")) @@ -322,6 +322,7 @@ class MultiViewSubProblemsGenerator: n_classes=self.n_classes, shuffle=False, random_state=self.rs, + cov=3., **self.sub_problem_configurations[ view_index]) @@ -421,8 +422,6 @@ class MultiViewSubProblemsGenerator: Randomly selects the examples that will participate to complementarity (well described by a fraction of the views) """ - n_comp = [int(self.complementarity_level[class_index]*self.n_views) - for class_index in range(self.n_classes)] if ((self.complementarity * self.n_examples_per_class)[0] > np.array( [len(inds) for inds in self.available_init_indices])).any(): raise ValueError(