Package training code to avoid sys.path hacks #2856
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
reuben
force-pushed
the
training-install
branch
6 times, most recently
from
3525f9f
to
a434165
Compare
reuben
force-pushed
the
training-install
branch
from
573202b
to
a05baa3
Compare
|
I'm asking for review from y'all three mostly so you're aware of this big change. The vast majority of it is just shuffling code from one place to the other and adapting imports, so don't feel like you have to review line by line. |
lissyx
reviewed
Mar 25, 2020
lissyx
reviewed
Mar 26, 2020
lissyx
reviewed
Mar 26, 2020
lissyx
reviewed
Mar 26, 2020
lissyx
approved these changes
Mar 26, 2020
|
@reuben Could we imagine a way to be able to detect if the code has not been installed using |
|
@lissyx it will not run if the package has not been installed. |
kdavis-mozilla
approved these changes
Mar 31, 2020
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes it so that the training code is actually installable, and avoids the need for
sys.pathhacks to import things. Now we have proper relative imports. For development, one should dopip install -e .in the root folder. This will install the training code in editable mode, meaning you can make changes to the code and they'll be reflected instantly (it's just a symbolic link).The biggest catch here is assumptions about paths and
cwd. Code should use file-relative paths instead of assuming what thecwdis. For paths that are received directly from the user nothing needs to be done as they are already relative tocwd.I've removed the
sys.pathhacks from the importers and fixed any importing inconsistencies. I've also left compatibility scripts inDeepSpeech.py,evaluate.pyandutil/taskcluster.py, since we've been advertising these for a while. We can also deprecate them in favor of more robust solutions, such as adding entry points in the setup script which add PATH-visible commands, or simply telling users to use e.g.python -m deepspeech_training.traininstead ofpython DeepSpeech.py.I've also included some small linter fixes since it was throwing a bunch of problems, and fixed
stats.pywhich was broken by the SDB PR. Sorry for not breaking it all in commits, I was working quickly and by the time things fell into place it was too late, specially with all thegit mvs.