Merge pull request #67 from amzn/tidy_up_leap

Tidy up leap folder
amzn · Mar 9, 2020 · ef5c201 · ef5c201
2 parents 1af6bc6 + 3797526
commit ef5c201
Show file tree

Hide file tree

Showing 14 changed files with 33 additions and 20 deletions.
diff --git a/leap/README.md b/leap/README.md
@@ -1,31 +1,44 @@
-## leap: meta-gradient path learner in MXNet
-
+## leap: meta-gradient path learner in MXNet  
 --------------------------------------------------------------------------------
 
-MXNet implementation of  "leap", the meta-gradient path learner published in ICLR 2019: [(link)](https://arxiv.org/abs/1812.01054) by S. Flennerhag, P. G. Moreno, N. Lawrence, A. Damianou.
+## Introduction  
 
+This is the MXNet implementation of  "leap", the meta-gradient path learner published in ICLR 2019: [(link)](https://arxiv.org/abs/1812.01054) by S. Flennerhag, P. G. Moreno, N. Lawrence, A. Damianou.
+
+Please cite our work if you find it useful:
+```
+@inproceedings{
+   flennerhag2018transferring,
+   title={Transferring Knowledge across Learning Processes},
+   author={Sebastian Flennerhag and Pablo Garcia Moreno and Neil Lawrence and Andreas Damianou},
+   booktitle={International Conference on Learning Representations},
+   year={2019},
+   url={https://openreview.net/forum?id=HygBZnRctX}
+}
+```
 
 ## Getting Started
-Check the `demos` and `test` folders. 
+Check the `demos` folder. The `.ipynb` file can be run in Jupyter [lab](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html) or [notebook](https://jupyter.readthedocs.io/en/latest/install.html).
 
 
 ## Installation
 * __Dependencies:__
 Primary dependency is MXNet >=1.2. See all requirements in [setup.py](setup.py).
 * __Supported architectures / versions:__
-Python 3.6+ on MacOS and Amazon Linux. 
+Python 3.6+ on MacOS and Amazon Linux.
 
 
 -  __Install from source:__
 To install leap from source, after cloning the repository run the following from the xfer/leap directory:
 ```
 pip install .
 ```
-
-Alternatively you can install with:
+Alternatively, you can install with:
 ```
-python setup.py install 
+python setup.py install
 ```
+For installing in editable/development mode, the above commands become respectively:
+`pip install -e .` and `python setup.py develop` .
 
 To confirm installation, run:
 ```python

diff --git a/leap/test/mxnet_test.py → leap/demos/mxnet_test.py b/leap/test/mxnet_test.py → leap/demos/mxnet_test.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/__init__.py b/leap/leap/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/config.py b/leap/leap/config.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/data.py b/leap/leap/data.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/leap.py b/leap/leap/leap.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/leap_meta_repurposer.py b/leap/leap/leap_meta_repurposer.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/meta_repurposer.py b/leap/leap/meta_repurposer.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/metalogger.py b/leap/leap/metalogger.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/onmiglot.py b/leap/leap/onmiglot.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/synthetic_data.py b/leap/leap/synthetic_data.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/updaters.py b/leap/leap/updaters.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/leap/utils.py b/leap/leap/utils.py
@@ -1,4 +1,4 @@
-# Copyright 2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 #   Licensed under the Apache License, Version 2.0 (the "License").
 #   You may not use this file except in compliance with the License.

diff --git a/leap/test/__init__.py b/leap/test/__init__.py