Metadata-Version: 1.1
Name: kumparanian
Version: 0.0.5
Summary: Kumparanian CLI
Home-page: https://github.com/kumparan/kumparanian
Author: Bayu Aldi Yansyah
Author-email: bayualdiyansyah@gmail.com
License: BSD 3-Clause License
Description-Content-Type: UNKNOWN
Description: Kumparanian |Build Status| |PyPI version|
        =========================================
        
        Kumparanian is a set of workflows that optimize Kumparan’s data
        engineering and data scientist hiring process. It cuts down 1-2 working
        day(s) submission review process to just less than an hour.
        
        If you are our candidate, you need to install ``kumparanian`` using
        following command:
        
        ::
        
            pip install kumparanian 
        
        consult its help command:
        
        ::
        
            % kumparanian ds --help
            Usage: kumparanian ds [OPTIONS] COMMAND [ARGS]...
        
              For Data Scientist role.
        
              Before you submit your trained model, you can verify your trained model
              using the following command:
        
              $ kumparanian ds verify YOURMODEL.pickle
        
              Use the following command to evaluate your trained model against your test
              dataset:
        
              $ kumparanian ds evaluate YOURMODEL.pickle test_file.csv
        
            Options:
              --help  Show this message and exit.
        
            Commands:
              evaluate  Evaluate the model
              verify    Verify the model
        
              If you found any issues, feel free report it at:
              https://github.com/kumparan/kumparanian/issues
        
        then read our assessment and you should be good.
        
        Subsequent sections are not required for candidate as it intended only
        for project’s documentation purpose.
        
        Kumparan’s Model Interface
        --------------------------
        
        The first component of Kumparanian is a `Kumparan’s Model
        Interface <./interface/model.py>`__. We’ve designed an interface for
        Machine Learning model that allows us to design a problem to have
        deterministic result.
        
        The model interface contains 3 required methods: ``train``, ``predict``
        and ``save``. The candidate will solve the assessment test by implement
        the ``train`` and ``predict`` methods. We provide ``save`` method to
        helps the candidate to save the trained model.
        
        Read more about the `Kumparan’s Model
        Interface <./interface/README.md>`__.
        
        Kumparanian CLI
        ---------------
        
        The second component of Kumparanian is a ``kumparanian(1)``. This CLI
        will help the candidate to verify and test their model while also help
        our team to evaluate the candidate’s trained model.
        
        ``kumparanian(1)`` can be installed via the following command:
        
        ::
        
            pip install kumparanian
        
        To get started, run the following command:
        
        ::
        
            kumparanian --help
        
        If you found any issue, please open new issue here
        `kumparanian/issues <https://github.com/kumparan/kumparanian/issues>`__.
        
        .. |Build Status| image:: https://travis-ci.org/kumparan/kumparanian.svg?branch=master
           :target: https://travis-ci.org/kumparan/kumparanian
        .. |PyPI version| image:: https://badge.fury.io/py/kumparanian.svg
           :target: https://badge.fury.io/py/kumparanian
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
