Moved leap from contrib to root folder #66
Conversation
| - __Install from source:__ | ||
| To install leap from source, after cloning the repository run the following from the top-level directory: | ||
| ``` | ||
| pip install . |
There was a problem hiding this comment.
-e flag for editable for development. Potentially add separate instructions for development
|
|
||
|
|
||
| ## Getting Started | ||
| Check the `demos` and `test` folders. |
There was a problem hiding this comment.
Consider adding link to installing jupyter/jupyter lab.
The mxnet_test seems more like a demo than a test since no checks are done and it cannot be run with any normal test runner (e.g. pytest, unittest). Maybe it can move to the demo folder?
To run the demo notebook, the user currently needs to first install leap but you can get around it with either changing the directory or adding the leap directory to the pythonpath. There doesn't really seem to be a general convention but xfer-ml requires the the package to be installed which I think is fine to continue as a convention for the repo.
|
|
||
| [bumpversion:file:leap/__version__.py] | ||
|
|
||
| [coverage:run] |
There was a problem hiding this comment.
The coverage settings can be removed since there won't be CI tests running on this
| ``` | ||
| And confirm that version returned matches the expected package version number. | ||
|
|
||
|
|
There was a problem hiding this comment.
Do we need to add a request that if this code is used to please cite the paper?
| @@ -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. | |||
There was a problem hiding this comment.
Should all these files be changed to be 2020?
Co-Authored-By: Jordan <jmas@live.co.uk>
Co-Authored-By: Jordan <jmas@live.co.uk>
Co-Authored-By: Jordan <jmas@live.co.uk>
They do! |
Issue #, if available:
Description of changes:
Moved xfer/xfer-ml/contrib/leap into xfer/leap. The reason for that is that the restructure has all files in flat structure under xfer, instead of inside xfer-ml (which makes sense since e.g. leap does not have dependencies in xfer-ml).
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.