From 50e94c8887c864a9109b01479807c21f0a8d2fad Mon Sep 17 00:00:00 2001 From: smilesun Date: Sun, 7 Jan 2024 14:01:42 +0100 Subject: [PATCH] ver 0.3.3 stable inner product --- README.md | 7 +++++-- docs/conf.py | 6 +++--- docs/doc_mldg.md | 4 ++++ docs/index.rst | 1 + pyproject.toml | 2 +- setup.py | 2 +- 6 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 docs/doc_mldg.md diff --git a/README.md b/README.md index bf39bf4fa..649940f4b 100644 --- a/README.md +++ b/README.md @@ -63,10 +63,13 @@ See example here: [Transformer as feature extractor, decorate JIGEN with DANN, t ### Benchmark different methods DomainLab provides a powerful benchmark functionality. -To benchmark several algorithms(combination of neural networks, models, trainers and associated hyperparameters), a single line command along with a benchmark configuration files is sufficient. See details in [Benchmarks](./docs/doc_benchmark.md) +To benchmark several algorithms(combination of neural networks, models, trainers and associated hyperparameters), a single line command along with a benchmark configuration files is sufficient. See details in [benchmarks documentation and tutorial](./docs/doc_benchmark.md) One could simply run -`bash run_benchmark_slurm.sh your_benchmark_configuration.yaml` to launch different experiments with specified configuraiton. For example, the following result (without any augmentation like flip) is for PACS dataset. +`bash run_benchmark_slurm.sh your_benchmark_configuration.yaml` to launch different experiments with specified configuraiton. + + +For example, the following result (without any augmentation like flip) is for PACS dataset.
diff --git a/docs/conf.py b/docs/conf.py index a3c1e4243..0d5d79a76 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -181,7 +181,7 @@ { "href": "doc_benchmark", "internal": True, - "title": "Benchmarks"}, + "title": "Benchmarks tutorial"}, { "href": "doc_output", @@ -198,7 +198,7 @@ # }, ], "heroes": { - "index": "DomainLab for modular domain generalization", + "index": "DomainLab for modular domain generalization in deep learning", "customization": "Configuration options to personalize your site.", }, "version_dropdown": False, @@ -266,7 +266,7 @@ "DomainLab Documentation", author, "domainlab", - "A pytorch platform for domain generalization", + "A pytorch platform of modular domain generalization for deep learning", "Miscellaneous", ), ] diff --git a/docs/doc_mldg.md b/docs/doc_mldg.md new file mode 100644 index 000000000..694f4b3d8 --- /dev/null +++ b/docs/doc_mldg.md @@ -0,0 +1,4 @@ +# Trainer MLDG +## Meta Learning Domain Generalization + +Li, Da, et al. "Learning to generalize: Meta-learning for domain generalization." Proceedings of the AAAI conference on artificial intelligence. Vol. 32. No. 1. 2018. diff --git a/docs/index.rst b/docs/index.rst index 604c6c621..96c8c7fe6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,6 +18,7 @@ Welcome to domainlab's documentation! docMatchDG docDIAL docFishr + doc_mldg Indices and tables diff --git a/pyproject.toml b/pyproject.toml index 46e973627..bd694357c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "domainlab" -version = "0.3.2" +version = "0.3.3" readme = "README.md" repository = "https://github.com/marrlab/DomainLab" homepage = "https://marrlab.github.io/DomainLab/" diff --git a/setup.py b/setup.py index ee613efa7..3cdb4c7fb 100644 --- a/setup.py +++ b/setup.py @@ -35,7 +35,7 @@ def copy_dir(dir_path="zdata"): package_data = { 'zdata': [f for f in copy_dir()], }, - version='0.3.2', + version='0.3.3', description='Library of modular domain generalization for deep learning', url='https://github.com/marrlab/DomainLab', author='Xudong Sun, et.al.',