[WIP] Modularize code for MAX model

System-T / DimSim

Apache License 2.0

120 stars 23 forks source link

[WIP] Modularize code for MAX model #3

Closed kmh4321 closed 5 years ago

kmh4321 commented 5 years ago

This PR is to modularize the code from the original repo into different modules like core, data and utils.
All the functions exposed directly to the user and immediate internal functions can be found in core. The immediate internal functions have been prefixed with a __ to indicate internal / private use.
All internal functions (mainly pinyin converters and a few other non-essential functions) can be found in utils.
The data pickle files can be found in data.
Test cases can be found under tests.

TODO:

[ ] finalze name of model
[ ] update readme
[ ] add code comments/docstrings
[ ] add more test cases (optional)
[ ] add TravisCI
[ ] add exception handler

frreiss commented 5 years ago

@kmh4321 looks like you accidentally imported some MacOS .DS_Store files. You should remove those files from this branch an add ".DS_Store" to .gitignore.

frreiss commented 5 years ago

@kmh4321: Can you please update the the description for this PR with a list of high-level changes that are included in this change set? I can reverse-engineer most of the actions you performed by looking at the diff, but it would be easier to understand if there was an exhaustive list.

Also, what testing has been done on your branch?

kmh4321 commented 5 years ago

@frreiss

@kmh4321 looks like you accidentally imported some MacOS .DS_Store files. You should remove those files from this branch an add ".DS_Store" to .gitignore.

I have already done this. The .DS_Store files in the git changelog are the deletions I made from the original version.

@kmh4321: Can you please update the the description for this PR with a list of high-level changes that are included in this change set? I can reverse-engineer most of the actions you performed by looking at the diff, but it would be easier to understand if there was an exhaustive list.

Sure. I have basically broken down this file from the original repo into different modules like core, data and utils in my branch/fork. I'll update the same in the PR description. There still isn't the code similar to other max models to raise exceptions/ return response codes for invalid inputs or other kinds of errors. I can add it on the TODO list.

Also, what testing has been done on your branch?

I have some preliminary tests which run automatically during the build process. Need to setup travis to run it as well.

kmh4321 commented 5 years ago

cc: @qk63030898 can you please review this at your convenience?