Manual Setup

SDK requires poetry. You can find install instructuction here

Clone the repo to local folder

git clone https://github.com/PuremlHQ/PureML

Navigate to packages > sdk

poetry install
poetry build

Folder Structure

.
├── License
├── README.md
├── change_log.md
├── pureml
│   ├── __init__.py
│   ├── cli
│   │   ├── __init__.py
│   │   ├── auth.py
│   │   ├── helpers.py
│   │   ├── main.py
│   │   ├── orgs.py
│   │   ├── public.pem
│   │   ├── puremlconfig.py
│   │   └── secrets.py
│   ├── components
│   │   ├── __init__.py
│   │   ├── auth.py
│   │   ├── dataset.py
│   │   ├── log
│   │   │   ├── __init__.py
│   │   │   ├── arrays.py
│   │   │   ├── artifacts.py
│   │   │   ├── audio.py
│   │   │   ├── figure.py
│   │   │   ├── image.py
│   │   │   ├── log.py
│   │   │   ├── metrics.py
│   │   │   ├── params.py
│   │   │   ├── pip_requirement.py
│   │   │   ├── predict.py
│   │   │   ├── resources.py
│   │   │   ├── tabular.py
│   │   │   └── video.py
│   │   └── model.py
│   ├── config
│   │   ├── __init__.py
│   │   └── parser.py
│   ├── decorators
│   │   ├── __init__.py
│   │   ├── dataset.py
│   │   ├── load_data.py
│   │   ├── model.py
│   │   ├── pip_requirements.py
│   │   ├── predict.py
│   │   └── transformer.py
│   ├── evaluate
│   │   ├── __init__.py
│   │   ├── classification.py
│   │   ├── eval.py
│   │   ├── grade.py
│   │   ├── metrics
│   │   │   ├── __init__.py
│   │   │   ├── accuracy.py
│   │   │   ├── base.py
│   │   │   ├── confusion_matrix.py
│   │   │   ├── f1.py
│   │   │   ├── mae.py
│   │   │   ├── mse.py
│   │   │   ├── precision.py
│   │   │   ├── recall.py
│   │   │   └── roc_auc.py
│   │   └── regression.py
│   ├── lineage
│   │   ├── __init__.py
│   │   └── data
│   │       ├── __init__.py
│   │       └── create_lineage.py
│   ├── package
│   │   ├── __init__.py
│   │   ├── docker.py
│   │   └── fastapi.py
│   ├── packaging
│   │   ├── __init__.py
│   │   ├── errors.py
│   │   ├── model_framework.py
│   │   ├── model_packaging
│   │   │   ├── __init__.py
│   │   │   ├── catboost.py
│   │   │   ├── custom.py
│   │   │   ├── keras.py
│   │   │   ├── lightgbm.py
│   │   │   ├── pytorch.py
│   │   │   ├── pytorch_tabnet.py
│   │   │   ├── sklearn.py
│   │   │   ├── tensorflow.py
│   │   │   └── xgboost.py
│   │   ├── packaging.py
│   │   └── packaging_utils.py
│   ├── predictor
│   │   ├── __init__.py
│   │   └── predictor.py
│   ├── schema
│   │   ├── __init__.py
│   │   ├── backend.py
│   │   ├── config.py
│   │   ├── dataset.py
│   │   ├── env.py
│   │   ├── log.py
│   │   ├── model.py
│   │   ├── packaging.py
│   │   ├── paths.py
│   │   ├── predict.py
│   │   ├── request.py
│   │   ├── singleton.py
│   │   ├── storage.py
│   │   └── types.py
│   ├── settings
│   │   ├── __init__.py
│   │   ├── backend.py
│   │   └── storage.py
│   └── utils
│       ├── __init__.py
│       ├── config.py
│       ├── constants.py
│       ├── env.py
│       ├── hash.py
│       ├── log_utils.py
│       ├── package.py
│       ├── pipeline.py
│       ├── predict.py
│       ├── readme.py
│       ├── resources.py
│       ├── source_code.py
│       ├── types.py
│       └── version_utils.py
├── pyproject.toml
└── tests
    ├── __init__.py
    ├── components
    │   ├── __init__.py
    │   ├── test_auth.py
    │   ├── test_dataset.py
    │   ├── test_metrics.py
    │   ├── test_models.py
    │   ├── test_params.py
    │   └── test_projects.py
    └── models
        ├── __init__.py
        └── saving
            ├── __init__.py
            ├── test_catboost.py
            ├── test_keras.py
            ├── test_lightgbm.py
            ├── test_pytorch.py
            ├── test_sklearn.py
            ├── test_tensorflow.py
            └── test_xgboost.py

Reporting Bugs

To report any bugs you have faced while using PureML package, please

1. Report it in Discord channel
2. Open an issue

Contributing and Developing

Lets work together to improve the features for everyone. Here's step one for you to go through our Contributing Guide. We are already waiting for amazing ideas and features which you all have got.

Work with mutual respect. Please take a look at our public Roadmap here.

Community

To get quick updates of feature releases of PureML, follow us on:

📄 License

See the Apache-2.0 file for licensing information.