simpliml


Namesimpliml JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/rajaddr/simpliml
SummaryMachine Learning, Artificial Intelligence, Mathematics
upload_time2024-12-28 13:50:46
maintainerNone
docs_urlNone
authorDharmaraj D
requires_python<3.13,>=3.9
licenseNone
keywords forecast time series machine learning deep learning artificial intelligence mathematics
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">

![SimpliML](https://i.ibb.co/KWCTBQP/NameSml.png) 

[![Python](https://img.shields.io/static/v1?label=Python&labelColor=007676&message=>=3.9,<3.13&color=01C0C0&style=flat&logoColor=01C0C0&logo=python)](https://pypi.org/project/simpliml/)
[![Version](https://img.shields.io/static/v1?label=Version&labelColor=007676&message=1.1.0&color=01C0C0&style=flat)](https://pypi.org/project/simpliml/)
[![Package Status](https://img.shields.io/static/v1?label=Status&labelColor=007676&message=Planning&color=01C0C0&style=flat)](https://pypi.org/project/simpliml/)
[![License](https://img.shields.io/static/v1?label=License&labelColor=007676&message=MIT&color=01C0C0&style=flat)](https://github.com/rajaddr/simpliml/blob/master/LICENSE)
<hr>
</div>

## Project description
**SimpliML** is a versatile machine learning library designed to be a one-stop solution for the entire data lifecycle. Whether you're preparing raw data or deploying advanced predictive models, *SimpliML* simplifies every step of the machine learning process.  

## Key Features  

- **Data Cleansing and Cleaning**  
  Simplify the preprocessing of raw data to ensure accurate and reliable model performance.  

- **Data Analysis**  
  Explore and analyze data with powerful, easy-to-use tools to uncover actionable insights.  

- **Model Execution and Prediction**  
  Train, validate, and deploy machine learning models seamlessly for accurate and efficient predictions.  

- **Forecasting and Optimization**  
  Perform precise forecasting and optimize your decision-making processes with ease.  

## Why Choose SimpliML?  

***SimpliML*** is designed for data scientists, ML engineers, and enthusiasts who need a reliable, efficient, and easy-to-use toolkit for managing the entire machine learning workflow.  

Get started today and unlock the full potential of your data with **SimpliML**!  

## Links
- Binary installers : [Python Package Index (PyPI)](https://pypi.org/project/simpliml)
- Source code repository : [GIT](https://github.com/rajaddr/simpliml) 
- Issue tracker : [Issue](https://github.com/rajaddr/simpliml/issues) 
- Changelog : [Changelog](https://github.com/rajaddr/simpliml/blob/master/CHANGELOG.md) 

## Installation
```sh
# or PyPI
pip install simpliml
```

## Dependencies
![Pandas](https://img.shields.io/static/v1?label=Pandas&labelColor=007676&message=>=2.2.3&color=01C0C0&style=flat&logoColor=01C0C0&logo=pandas)
![NumPy](https://img.shields.io/static/v1?label=NumPy&labelColor=007676&message=>=1.26.2&color=01C0C0&style=flat&logoColor=01C0C0&logo=NumPy)
![SciPy](https://img.shields.io/static/v1?label=SciPy&labelColor=007676&message=>=1.14.1&color=01C0C0&style=flat&logoColor=01C0C0&logo=SciPy)
![scikit-learn](https://img.shields.io/static/v1?label=scikit-learn&labelColor=007676&message=>=1.5.2&color=01C0C0&style=flat&logoColor=01C0C0&logo=scikit-learn)
![Torch](https://img.shields.io/static/v1?label=Torch&labelColor=007676&message=>=2.5.1&color=01C0C0&style=flat&logoColor=01C0C0&logo=PyTorch)
![Statsmodels](https://img.shields.io/static/v1?label=statsmodels&labelColor=007676&message=>=0.14.4&color=01C0C0&style=flat&logoColor=01C0C0&logo=)
![Altair](https://img.shields.io/static/v1?label=Altair&labelColor=007676&message=>=5.5.0&color=01C0C0&style=flat&logoColor=01C0C0&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAACXBIWXMAAAWJAAAFiQFtaJ36AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAATSSURBVHgB7d07biRVGIbhv7rtYCSCjiEZESELS70BpFoAiM4IcUDOElgTK6iAjIRVkLCBkXxR4ZYbZHnaM+2u27k8T+zMelWnXJ+rIgAAAAAAAAAAAAAAAAAAAAAAAABIWhMcddtdbd/98+dfkZmHn77wOx3RKjhq1ax/DaonkNe1QfUEcsRtd33TR7wPqieQI5omfg4IgXzkQ/fN+3C84kAgL6zi4ibgQCAvrJvG8Yr/CeSZu+7b1s05zwnkmcbVgxcEcrC/OX+8etwEPCOQg3VctgEvCOSgaXrTEj4ikPjv2UezDXhBII8um8vfAo4QyJM24IjqAzFM5FOqD6Rp4seAV1QdyGGYuAt4RdWBePbB51QdyKoJf73ik6oNxDCRU1QbiGEip6gykL7bbno355ygykDu4mEfxybgM6oMxEsZOFV1gXgpA29RXSCGibxFjUesNuBEVQVy313vPPvgLaoKpHdzzhtVE4hhIueoJhDDRM5RTSCGiZyjikAMEzlXFYEYJnKu4gMxTGSI4gMxTGSI4gMxTGSIogMxTGSoogMxTGSo0o9YbcAAxQZimMgYyr2CeGMiIygyEF+LYixFBmKYyFiKDMQwkbEUF8htd7V1c85Yigtk1ax9a5DRlHjEagNGchEFKflrUd9/uT7tB//40Ecifv/uXROZK+oKYpjI2IoJxDCRKRQTyCoubgJGVkwga/9WywSKCMRLGZhKEYF4KQNTyT4Qw0SmlH0gholMKftAmqY3LWEyWQeyHyY+JrINmEjWgRgmMrXcj1htwISyDaTkYSLpyDYQw0TmkGUghonMJctADBOZS5aBGCYyl+wCMUxkTtkFYpjInLIKxDCRuWUViGEic8sqEMNE5pZNIE/PPgwTmVc2gfhaFEvI6YjVBswsi0AME1lKFoE0vhbFQpIP5DBM3AUsIPlAPPtgSckH4mtRLCnpQAwTWVrSgRgmsrRkA+m77aZ3c87Ckg3kLh72cWwCFpRsIF7KQAqSDMRLGUhFkoEYJpKKVI9YbUACkgvkvrveefZBKpILpHdzTkKSCsQwkdQkFYhhIqlJKhDDRFKTTCCGiaQomUAME0lREoEYJpKqJAIxTCRVSQRimEiqFg/EMJGUXcTC9sPEPsjJL19fnvZzf98n86v94auLJs6QwhGrDUjUooEYJpK6Za8g3phI4hYLxNeiyMFigRgmkoPFAjFMJAeLBHLbXW3dnJODRQJZNWvfGiQLSx2x2oAMzB6Ir0WRk9kDMUwkJ7MGYphIbmYNZBUXNwEZmTWQtX+rJTOzBeKlDORotkC8lIEczRKIYSK5miUQw0RyNUsgTdOblpClyQPZDxMfE9kGZGjyQAwTydkcR6w2IFOTBmKYSO4mDcQwkdxNFohhIiWYLBDDREowWSCGiZRgkkAMEynFJIEYJlKK0QMxTKQkowdimEhJRg/EMJGSjBrI07MPw0TKMWog+69FBRRk7CNWG1CQ0QIxTKREowXS+FoUBRolkMMwcRdQmFEC8eyDUo0SiK9FUarBgRgmUrLBgRgmUrJBgfTddtO7OadggwK5i4d9HJuAQg0KxEsZKN3ZgXgpAzU4OxDDRGow5IjVBhTurEDuu+udZx8AAAAAAAAAAAAAAAAAAAAAAAAAwOL+BcH67Bny8ncOAAAAAElFTkSuQmCC)
![Matplotlib](https://img.shields.io/static/v1?label=Matplotlib&labelColor=007676&message=>=3.9.3&color=01C0C0&style=flat&logoColor=01C0C0&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMjgiIGhlaWdodD0iMTI4IiBzdHJva2U9IiM3NzciIGZpbGwtb3BhY2l0eT0iLjgiPgo8cGF0aCBmaWxsPSIjRkZGIiBkPSJtNjMsMWE2Myw2MyAwIDEsMCAyLDB6bTAsMTRhNDksNDkgMCAxLDAgMiwwem0wLDE0YTM1LDM1IDAgMSwwCjIsMHptMCwxNGEyMSwyMSAwIDEsMCAyLDB6bTAsMTRhNyw3IDAgMSwwIDIsMHptNjQsN0gxbTEwOC00NS05MCw5MG05MCwwLTkwLTkwbTQ1LTE4djEyNiIvPgo8cGF0aCBmaWxsPSIjRjYwIiBkPSJtNTAsOC0yMCwxMCA2OCw5MiAxMC0xMEw2NCw2NHoiLz4KPHBhdGggZmlsbD0iI0ZDMCIgZD0ibTE3LDUwdjI4TDY0LDY0eiIvPgo8cGF0aCBmaWxsPSIjN0Y3IiBkPSJtNjQsNjQgNiwzNUg1OHoiLz4KPHBhdGggZmlsbD0iI0NGMyIgZD0ibTY0LDY0IDEzLTQwIDksNXoiLz4KPHBhdGggZmlsbD0iIzA0RiIgZD0ibTY0LDY0IDE0LTYgMSw0emwtMjYsMTMgMyw0eiIvPgo8L3N2Zz4=)
![Seaborn](https://img.shields.io/static/v1?label=seaborn&labelColor=007676&message=>=0.13.2&color=01C0C0&style=flat&logoColor=01C0C0&logo=)
![pmdarima](https://img.shields.io/static/v1?label=pmdarima&labelColor=007676&message=>=2.0.4&color=01C0C0&style=flat&logoColor=01C0C0&logo=)

## Usage

## 1) Time Series
- **Pre-built Models:** Includes popular time series forecasting models like ARIMA, SARIMA, torch, and more.
- **Seamless Integration:** Load data, preprocess, and run forecasting models in one place.
- **Automatic Forecasting:** Automatically generates forecasts for future time steps once a model is selected.
- **Visualization:** Built-in tools for visualizing both historical data and forecasted values.
- **Customizable:** Fine-tune model parameters to suit your specific use case.
- **Extensive Documentation:** Detailed guides and examples to help you get started.


#### Import SimpliML Time Series
```python
import pandas as pd
import simpliml.timeseriesforecast as tsf
```

#### Build Time Series Data
```python
sourceDF = pd.read_csv("") # Any Input data read
dataDF, futureDF = tsf.generateTSData(sourceDF, format='%Y-%m', freq='MS', periods=30)
```
Parameters:-
- format : str, optional 
  - Please refer [strftime-and-strptime-behavior](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior)
- freq : str, optional
  - Please refer [timeseries-offset-aliases](https://pandas.pydata.org/docs/user_guide/timeseries.html#timeseries-offset-aliases)
- periods : int, optional
  - Forcasting time period

#### Analysis Data
```python
tsf.analysisData(dataDF) # This will work only in interactive computational environment like Jupyter Notebook/lab/hub ..etc 
```

#### Build Model and forcast
```python
mdlResult = tsf.runModel(dataDF, futureDF, seasonal=12, modelApproach = 'FAST', testSize=80)  # Single Process Thread
(OR)
mdlResult = tsf.runThreadModel(dataDF, futureDF, seasonal=12, modelApproach = 'FAST', testSize=80) # Single Process Multiple Thread (Thread : CPU Count * 2)
(OR)
mdlResult = tsf.runProcessModel(dataDF, futureDF, seasonal=12, modelApproach = 'FAST', testSize=80) # Multiple Process (Process : CPU Count / 4) # Advise to use only in Windows  
```
Parameters:-
- seasonal : int, optional
  - The number of periods in a complete seasonal cycle, 
  - Example 
    -  1 : Yearly data
    -  2 : Half-yearly data
    -  4 : Quarterly data 
    -  7 : Daily data with a weekly cycle
    - 52 : Weekly Data
- modelApproach : ["BEST", "FAST"], optional
  - BEST : Best model build with multiple permutation and combination
  - FAST : Fast model build with limited permutation and combination
- testSize : int, optional
  - Test Size by defult 80:20 rule


#### Model Result Analysis
```python
mdlOutPut = tsf.modelResult(dataDF, mdlResult, modelApproach='Best') 
```
Parameters:-
- modelApproach : str, optional
  - BEST MAPE analysis report and can pass the model name, get the analysis report


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rajaddr/simpliml",
    "name": "simpliml",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.13,>=3.9",
    "maintainer_email": null,
    "keywords": "Forecast Time Series Machine Learning Deep Learning Artificial Intelligence Mathematics",
    "author": "Dharmaraj D",
    "author_email": "rajaddr@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/03/fa/7a6d3a2383a3ca6b68d86fb9897977b3539c9c4e4c16295596312ba0ac44/simpliml-1.1.0.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\r\n\r\n![SimpliML](https://i.ibb.co/KWCTBQP/NameSml.png) \r\n\r\n[![Python](https://img.shields.io/static/v1?label=Python&labelColor=007676&message=>=3.9,<3.13&color=01C0C0&style=flat&logoColor=01C0C0&logo=python)](https://pypi.org/project/simpliml/)\r\n[![Version](https://img.shields.io/static/v1?label=Version&labelColor=007676&message=1.1.0&color=01C0C0&style=flat)](https://pypi.org/project/simpliml/)\r\n[![Package Status](https://img.shields.io/static/v1?label=Status&labelColor=007676&message=Planning&color=01C0C0&style=flat)](https://pypi.org/project/simpliml/)\r\n[![License](https://img.shields.io/static/v1?label=License&labelColor=007676&message=MIT&color=01C0C0&style=flat)](https://github.com/rajaddr/simpliml/blob/master/LICENSE)\r\n<hr>\r\n</div>\r\n\r\n## Project description\r\n**SimpliML** is a versatile machine learning library designed to be a one-stop solution for the entire data lifecycle. Whether you're preparing raw data or deploying advanced predictive models, *SimpliML* simplifies every step of the machine learning process.  \r\n\r\n## Key Features  \r\n\r\n- **Data Cleansing and Cleaning**  \r\n  Simplify the preprocessing of raw data to ensure accurate and reliable model performance.  \r\n\r\n- **Data Analysis**  \r\n  Explore and analyze data with powerful, easy-to-use tools to uncover actionable insights.  \r\n\r\n- **Model Execution and Prediction**  \r\n  Train, validate, and deploy machine learning models seamlessly for accurate and efficient predictions.  \r\n\r\n- **Forecasting and Optimization**  \r\n  Perform precise forecasting and optimize your decision-making processes with ease.  \r\n\r\n## Why Choose SimpliML?  \r\n\r\n***SimpliML*** is designed for data scientists, ML engineers, and enthusiasts who need a reliable, efficient, and easy-to-use toolkit for managing the entire machine learning workflow.  \r\n\r\nGet started today and unlock the full potential of your data with **SimpliML**!  \r\n\r\n## Links\r\n- Binary installers : [Python Package Index (PyPI)](https://pypi.org/project/simpliml)\r\n- Source code repository : [GIT](https://github.com/rajaddr/simpliml) \r\n- Issue tracker : [Issue](https://github.com/rajaddr/simpliml/issues) \r\n- Changelog : [Changelog](https://github.com/rajaddr/simpliml/blob/master/CHANGELOG.md) \r\n\r\n## Installation\r\n```sh\r\n# or PyPI\r\npip install simpliml\r\n```\r\n\r\n## Dependencies\r\n![Pandas](https://img.shields.io/static/v1?label=Pandas&labelColor=007676&message=>=2.2.3&color=01C0C0&style=flat&logoColor=01C0C0&logo=pandas)\r\n![NumPy](https://img.shields.io/static/v1?label=NumPy&labelColor=007676&message=>=1.26.2&color=01C0C0&style=flat&logoColor=01C0C0&logo=NumPy)\r\n![SciPy](https://img.shields.io/static/v1?label=SciPy&labelColor=007676&message=>=1.14.1&color=01C0C0&style=flat&logoColor=01C0C0&logo=SciPy)\r\n![scikit-learn](https://img.shields.io/static/v1?label=scikit-learn&labelColor=007676&message=>=1.5.2&color=01C0C0&style=flat&logoColor=01C0C0&logo=scikit-learn)\r\n![Torch](https://img.shields.io/static/v1?label=Torch&labelColor=007676&message=>=2.5.1&color=01C0C0&style=flat&logoColor=01C0C0&logo=PyTorch)\r\n![Statsmodels](https://img.shields.io/static/v1?label=statsmodels&labelColor=007676&message=>=0.14.4&color=01C0C0&style=flat&logoColor=01C0C0&logo=)\r\n![Altair](https://img.shields.io/static/v1?label=Altair&labelColor=007676&message=>=5.5.0&color=01C0C0&style=flat&logoColor=01C0C0&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAMgAAADICAYAAACtWK6eAAAACXBIWXMAAAWJAAAFiQFtaJ36AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAATSSURBVHgB7d07biRVGIbhv7rtYCSCjiEZESELS70BpFoAiM4IcUDOElgTK6iAjIRVkLCBkXxR4ZYbZHnaM+2u27k8T+zMelWnXJ+rIgAAAAAAAAAAAAAAAAAAAAAAAABIWhMcddtdbd/98+dfkZmHn77wOx3RKjhq1ax/DaonkNe1QfUEcsRtd33TR7wPqieQI5omfg4IgXzkQ/fN+3C84kAgL6zi4ibgQCAvrJvG8Yr/CeSZu+7b1s05zwnkmcbVgxcEcrC/OX+8etwEPCOQg3VctgEvCOSgaXrTEj4ikPjv2UezDXhBII8um8vfAo4QyJM24IjqAzFM5FOqD6Rp4seAV1QdyGGYuAt4RdWBePbB51QdyKoJf73ik6oNxDCRU1QbiGEip6gykL7bbno355ygykDu4mEfxybgM6oMxEsZOFV1gXgpA29RXSCGibxFjUesNuBEVQVy313vPPvgLaoKpHdzzhtVE4hhIueoJhDDRM5RTSCGiZyjikAMEzlXFYEYJnKu4gMxTGSI4gMxTGSI4gMxTGSIogMxTGSoogMxTGSo0o9YbcAAxQZimMgYyr2CeGMiIygyEF+LYixFBmKYyFiKDMQwkbEUF8htd7V1c85Yigtk1ax9a5DRlHjEagNGchEFKflrUd9/uT7tB//40Ecifv/uXROZK+oKYpjI2IoJxDCRKRQTyCoubgJGVkwga/9WywSKCMRLGZhKEYF4KQNTyT4Qw0SmlH0gholMKftAmqY3LWEyWQeyHyY+JrINmEjWgRgmMrXcj1htwISyDaTkYSLpyDYQw0TmkGUghonMJctADBOZS5aBGCYyl+wCMUxkTtkFYpjInLIKxDCRuWUViGEic8sqEMNE5pZNIE/PPgwTmVc2gfhaFEvI6YjVBswsi0AME1lKFoE0vhbFQpIP5DBM3AUsIPlAPPtgSckH4mtRLCnpQAwTWVrSgRgmsrRkA+m77aZ3c87Ckg3kLh72cWwCFpRsIF7KQAqSDMRLGUhFkoEYJpKKVI9YbUACkgvkvrveefZBKpILpHdzTkKSCsQwkdQkFYhhIqlJKhDDRFKTTCCGiaQomUAME0lREoEYJpKqJAIxTCRVSQRimEiqFg/EMJGUXcTC9sPEPsjJL19fnvZzf98n86v94auLJs6QwhGrDUjUooEYJpK6Za8g3phI4hYLxNeiyMFigRgmkoPFAjFMJAeLBHLbXW3dnJODRQJZNWvfGiQLSx2x2oAMzB6Ir0WRk9kDMUwkJ7MGYphIbmYNZBUXNwEZmTWQtX+rJTOzBeKlDORotkC8lIEczRKIYSK5miUQw0RyNUsgTdOblpClyQPZDxMfE9kGZGjyQAwTydkcR6w2IFOTBmKYSO4mDcQwkdxNFohhIiWYLBDDREowWSCGiZRgkkAMEynFJIEYJlKK0QMxTKQkowdimEhJRg/EMJGSjBrI07MPw0TKMWog+69FBRRk7CNWG1CQ0QIxTKREowXS+FoUBRolkMMwcRdQmFEC8eyDUo0SiK9FUarBgRgmUrLBgRgmUrJBgfTddtO7OadggwK5i4d9HJuAQg0KxEsZKN3ZgXgpAzU4OxDDRGow5IjVBhTurEDuu+udZx8AAAAAAAAAAAAAAAAAAAAAAAAAwOL+BcH67Bny8ncOAAAAAElFTkSuQmCC)\r\n![Matplotlib](https://img.shields.io/static/v1?label=Matplotlib&labelColor=007676&message=>=3.9.3&color=01C0C0&style=flat&logoColor=01C0C0&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4KPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxMjgiIGhlaWdodD0iMTI4IiBzdHJva2U9IiM3NzciIGZpbGwtb3BhY2l0eT0iLjgiPgo8cGF0aCBmaWxsPSIjRkZGIiBkPSJtNjMsMWE2Myw2MyAwIDEsMCAyLDB6bTAsMTRhNDksNDkgMCAxLDAgMiwwem0wLDE0YTM1LDM1IDAgMSwwCjIsMHptMCwxNGEyMSwyMSAwIDEsMCAyLDB6bTAsMTRhNyw3IDAgMSwwIDIsMHptNjQsN0gxbTEwOC00NS05MCw5MG05MCwwLTkwLTkwbTQ1LTE4djEyNiIvPgo8cGF0aCBmaWxsPSIjRjYwIiBkPSJtNTAsOC0yMCwxMCA2OCw5MiAxMC0xMEw2NCw2NHoiLz4KPHBhdGggZmlsbD0iI0ZDMCIgZD0ibTE3LDUwdjI4TDY0LDY0eiIvPgo8cGF0aCBmaWxsPSIjN0Y3IiBkPSJtNjQsNjQgNiwzNUg1OHoiLz4KPHBhdGggZmlsbD0iI0NGMyIgZD0ibTY0LDY0IDEzLTQwIDksNXoiLz4KPHBhdGggZmlsbD0iIzA0RiIgZD0ibTY0LDY0IDE0LTYgMSw0emwtMjYsMTMgMyw0eiIvPgo8L3N2Zz4=)\r\n![Seaborn](https://img.shields.io/static/v1?label=seaborn&labelColor=007676&message=>=0.13.2&color=01C0C0&style=flat&logoColor=01C0C0&logo=)\r\n![pmdarima](https://img.shields.io/static/v1?label=pmdarima&labelColor=007676&message=>=2.0.4&color=01C0C0&style=flat&logoColor=01C0C0&logo=)\r\n\r\n## Usage\r\n\r\n## 1) Time Series\r\n- **Pre-built Models:** Includes popular time series forecasting models like ARIMA, SARIMA, torch, and more.\r\n- **Seamless Integration:** Load data, preprocess, and run forecasting models in one place.\r\n- **Automatic Forecasting:** Automatically generates forecasts for future time steps once a model is selected.\r\n- **Visualization:** Built-in tools for visualizing both historical data and forecasted values.\r\n- **Customizable:** Fine-tune model parameters to suit your specific use case.\r\n- **Extensive Documentation:** Detailed guides and examples to help you get started.\r\n\r\n\r\n#### Import SimpliML Time Series\r\n```python\r\nimport pandas as pd\r\nimport simpliml.timeseriesforecast as tsf\r\n```\r\n\r\n#### Build Time Series Data\r\n```python\r\nsourceDF = pd.read_csv(\"\") # Any Input data read\r\ndataDF, futureDF = tsf.generateTSData(sourceDF, format='%Y-%m', freq='MS', periods=30)\r\n```\r\nParameters:-\r\n- format : str, optional \r\n  - Please refer [strftime-and-strptime-behavior](https://docs.python.org/3/library/datetime.html#strftime-and-strptime-behavior)\r\n- freq : str, optional\r\n  - Please refer [timeseries-offset-aliases](https://pandas.pydata.org/docs/user_guide/timeseries.html#timeseries-offset-aliases)\r\n- periods : int, optional\r\n  - Forcasting time period\r\n\r\n#### Analysis Data\r\n```python\r\ntsf.analysisData(dataDF) # This will work only in interactive computational environment like Jupyter Notebook/lab/hub ..etc \r\n```\r\n\r\n#### Build Model and forcast\r\n```python\r\nmdlResult = tsf.runModel(dataDF, futureDF, seasonal=12, modelApproach = 'FAST', testSize=80)  # Single Process Thread\r\n(OR)\r\nmdlResult = tsf.runThreadModel(dataDF, futureDF, seasonal=12, modelApproach = 'FAST', testSize=80) # Single Process Multiple Thread (Thread : CPU Count * 2)\r\n(OR)\r\nmdlResult = tsf.runProcessModel(dataDF, futureDF, seasonal=12, modelApproach = 'FAST', testSize=80) # Multiple Process (Process : CPU Count / 4) # Advise to use only in Windows  \r\n```\r\nParameters:-\r\n- seasonal : int, optional\r\n  - The number of periods in a complete seasonal cycle, \r\n  - Example \r\n    -  1 : Yearly data\r\n    -  2 : Half-yearly data\r\n    -  4 : Quarterly data \r\n    -  7 : Daily data with a weekly cycle\r\n    - 52 : Weekly Data\r\n- modelApproach : [\"BEST\", \"FAST\"], optional\r\n  - BEST : Best model build with multiple permutation and combination\r\n  - FAST : Fast model build with limited permutation and combination\r\n- testSize : int, optional\r\n  - Test Size by defult 80:20 rule\r\n\r\n\r\n#### Model Result Analysis\r\n```python\r\nmdlOutPut = tsf.modelResult(dataDF, mdlResult, modelApproach='Best') \r\n```\r\nParameters:-\r\n- modelApproach : str, optional\r\n  - BEST MAPE analysis report and can pass the model name, get the analysis report\r\n\r\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Machine Learning, Artificial Intelligence, Mathematics",
    "version": "1.1.0",
    "project_urls": {
        "Changelog": "https://github.com/rajaddr/simpliml/blob/master/CHANGELOG.md",
        "Homepage": "https://github.com/rajaddr/simpliml",
        "Issue Tracker": "https://github.com/rajaddr/simpliml/issues"
    },
    "split_keywords": [
        "forecast",
        "time",
        "series",
        "machine",
        "learning",
        "deep",
        "learning",
        "artificial",
        "intelligence",
        "mathematics"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "720ab2eb3fd52355181c541a9f99951cf60ac887abb637108799428638a20477",
                "md5": "961fbf992094e31eac2b1a07ca764048",
                "sha256": "3511fc36a4b15e38b62665ba0439450064eae978e907b72a7ba7cb6aef6bd72e"
            },
            "downloads": -1,
            "filename": "simpliml-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "961fbf992094e31eac2b1a07ca764048",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.13,>=3.9",
            "size": 18284,
            "upload_time": "2024-12-28T13:50:45",
            "upload_time_iso_8601": "2024-12-28T13:50:45.107207Z",
            "url": "https://files.pythonhosted.org/packages/72/0a/b2eb3fd52355181c541a9f99951cf60ac887abb637108799428638a20477/simpliml-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "03fa7a6d3a2383a3ca6b68d86fb9897977b3539c9c4e4c16295596312ba0ac44",
                "md5": "c0503b1212801545554ba3b4f56147e1",
                "sha256": "87ddb9a5a412fc4ca308b23924618eed855c311811e4a5389f54d39acf1d747c"
            },
            "downloads": -1,
            "filename": "simpliml-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c0503b1212801545554ba3b4f56147e1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.13,>=3.9",
            "size": 20420,
            "upload_time": "2024-12-28T13:50:46",
            "upload_time_iso_8601": "2024-12-28T13:50:46.967413Z",
            "url": "https://files.pythonhosted.org/packages/03/fa/7a6d3a2383a3ca6b68d86fb9897977b3539c9c4e4c16295596312ba0ac44/simpliml-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-28 13:50:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rajaddr",
    "github_project": "simpliml",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "simpliml"
}
        
Elapsed time: 0.43280s