Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.0 #15

Open
wants to merge 53 commits into
base: 2.0
Choose a base branch
from
Open

2.0 #15

wants to merge 53 commits into from

Conversation

theconsolelogger
Copy link
Collaborator

This pull request prepares NeuRec 2.0 for packaging. In contains changes to the structure of the project, documentation, and enhancements to improve interaction when used as an imported package.

Separated python files and documentation files by moving python files to the folder 'neurec'.
Moved NeuRec.properties file to conf folder.
Refactored reading of files due to project being converted into a package and not knowning the path to the package. Configuration and dataset files are now read in the neurec/util/reader module, using importlib_resources.
Establish the first set of documentation, including:
1. Installation
2. Get Started
3. Custom Model
theconsolelogger and others added 23 commits October 14, 2019 10:44
- Added file handler for logging to a file
- Replaced print statements with logging.info in models
- Set logger to root to show log output in Jupyter notebook
- Changed python packages to install from requirements.txt file
- Corrected base image tags
- Installed python 3.6
- Updated dockerfiles with neurec python package
- Updated docs with docker image location
- Add manifest file to add datasets to python package
- Added init file for modules
- Updated setup file with necessary details
Updated documentation:
- Updated 1. Installation with Github docker instructions
- Updated 2. Get Started with the latest settings and output
- Updated 3. Properties with the latest settings
- Added section on sequential and social models for 4. Custom Model

Improved properties functionality:
- Added ability to provide a list of conversions for a property value
- Optimised by performing conversion when loading the properties, rather than when reading a property
- Set recommender value to a lower case string

Updated python package details with the following:
- Update version number to 2.0.0
- Added README.md file as the long description
- Added package dependencies
@theconsolelogger theconsolelogger added the enhancement New feature or request label Nov 7, 2019
@theconsolelogger theconsolelogger self-assigned this Nov 7, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants