Metadata-Version: 2.1
Name: mf_algorithms
Version: 0.0.1
Summary: MF Algorithms contains various matrix factorization methods utilizing different iterative update rules.
Home-page: https://github.com/chaue/mf-algorithms
Author: Edwin Chau
Author-email: edwinchau@ucla.edu
License: MIT
Description: # MF Algorithms
        
        [![PyPI Version](https://img.shields.io/pypi/v/mf-algorithms.svg)](https://pypi.org/project/mf-algorithms/)
        [![Supported Python Versions](https://img.shields.io/pypi/pyversions/mf-algorithms.svg)](https://pypi.org/project/mf-algorithms/)
        
        MF Algorithms contains various matrix factorization methods utilizing different iterative update rules.
        
        ---
        
        ## Installation
        
        To install MF Algorithms, run this command in your terminal:
        
        ```bash
        $ pip install -U mf-algorithms
        ```
        
        This is the preferred method to install MF Algorithms, as it will always install the most recent stable release.
        
        If you don't have [pip](https://pip.pypa.io) installed, these [installation instructions](http://docs.python-guide.org/en/latest/starting/installation/) can guide
        you through the process.
        
        ## Quick Start
        ```python
        >>> from mf_algorithms import Example
        >>> a = Example()
        >>> a.get_value()
        10
        
        ```
        
        ## Citing
        If you use our work in an academic setting, please cite our paper:
        
        
        
        ## Development
        See [CONTRIBUTING.md](CONTRIBUTING.md) for information related to developing the code.
        
        #### Suggested Git Branch Strategy
        1. `master` is for the most up-to-date development, very rarely should you directly commit to this branch. Your day-to-day work should exist on branches separate from `master`. It is recommended to commit to development branches and make pull requests to master.4. It is recommended to use "Squash and Merge" commits when committing PR's. It makes each set of changes to `master`
        atomic and as a side effect naturally encourages small well defined PR's.
        
        
        #### Additional Optional Setup Steps:
        * Create an initial release to test.PyPI and PyPI.
            * Follow [This PyPA tutorial](https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives), starting from the "Generating distribution archives" section.
        
        * Create a blank github repository (without a README or .gitignore) and push the code to it.
        
        * Delete these setup instructions from `README.md` when you are finished with them.
        
Keywords: mf_algorithms
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research 
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: docs
Provides-Extra: setup
Provides-Extra: dev
Provides-Extra: all
