Skip to content

Commit

Permalink
cleaned up TOC and added exclusion headers
Browse files Browse the repository at this point in the history
  • Loading branch information
jestyr27 committed Nov 28, 2024
1 parent 458fd10 commit 63769d9
Showing 1 changed file with 86 additions and 64 deletions.
150 changes: 86 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,87 @@
# pyrizon
Python driven data assessment using pandas and flet

## Platform MVP Architecture

![Platform MVP Architecture](.images/mvp_architecture.png)

### File Workflow Architecture

![File Workflow Architecture](.images/file_workflow.png)

### Excalidraw Design

![Excalidraw Design](.images/ml_pipelines.excalidraw.svg)

## Installation

### Package manager
https://github.com/astral-sh/uv

### Dependencies

```bash
pip install uv
uv sync
```

#### Libraries

```python
import pandas as pd
#TFIDF Feature Extraction Scikit-learn
import sklearn.feature_extraction.text as sk_text
import mysql.connector
import dask
```

## Sample Data Sources

- [Kaggle](https://www.kaggle.com/datasets)
- [UCI Machine Learning Repository](https://archive.ics.uci.edu/ml/index.php)
- [Google Dataset Search](https://datasetsearch.research.google.com/)
- [Data.gov](https://www.data.gov/)

### Solar Flares

Data (CSV) : https://www.kaggle.com/datasets/khsamaha/solar-flares-rhessi
License (CC0) 1.0 : https://creativecommons.org/publicdomain/zero/1.0/

### Adult Census Data

Data : Becker,Barry and Kohavi,Ronny. (1996). Adult. UCI Machine Learning Repository. https://doi.org/10.24432/C5XW20.
License (Creative Commons Attribution 4.0) : https://creativecommons.org/licenses/by/4.0/legalcode

### Reference

- https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_csv.html
- https://scikit-learn.org/stable/modules/compose.html
- https://scikit-learn.org/stable/auto_examples/ensemble/plot_gradient_boosting_categorical.html
- https://scikit-learn.org/stable/auto_examples/classification/plot_classifier_comparison.html
- https://scikit-learn.org/stable/modules/metrics.html
- https://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.text.CountVectorizer.html
- https://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.DictVectorizer.html
- https://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.text.TfidfTransformer.html#sklearn.feature_extraction.text.TfidfTransformer
<!-- omit in toc -->
# pyrizon
Python driven data assessment using pandas and flet

<!-- omit in toc -->
## Table of Contents

- [Platform MVP Architecture](#platform-mvp-architecture)
- [File Workflow Architecture](#file-workflow-architecture)
- [Excalidraw Design](#excalidraw-design)
- [Installation](#installation)
- [Package manager](#package-manager)
- [Dependencies](#dependencies)
- [Libraries](#libraries)
- [Sample Data Sources](#sample-data-sources)
- [Solar Flares](#solar-flares)
- [Adult Census Data](#adult-census-data)
- [EUR USD 2002-2020 Forex Data](#eur-usd-2002-2020-forex-data)
- [Reference](#reference)

## Platform MVP Architecture

![Platform MVP Architecture](.images/mvp_architecture.png)

### File Workflow Architecture

![File Workflow Architecture](.images/file_workflow.png)

### Excalidraw Design

![Excalidraw Design](.images/ml_pipelines.excalidraw.svg)

## Installation

### Package manager
https://github.com/astral-sh/uv

### Dependencies

```bash
pip install uv
uv sync
```

#### Libraries

```python
import pandas as pd
#TFIDF Feature Extraction Scikit-learn
import sklearn.feature_extraction.text as sk_text
import mysql.connector
import dask
```

## Sample Data Sources

- [Kaggle](https://www.kaggle.com/datasets)
- [UCI Machine Learning Repository](https://archive.ics.uci.edu/ml/index.php)
- [Google Dataset Search](https://datasetsearch.research.google.com/)
- [Data.gov](https://www.data.gov/)

### Solar Flares

Data (CSV) : https://www.kaggle.com/datasets/khsamaha/solar-flares-rhessi
License (CC0) 1.0 : https://creativecommons.org/publicdomain/zero/1.0/

### Adult Census Data

Data : Becker,Barry and Kohavi,Ronny. (1996). Adult. UCI Machine Learning Repository. https://doi.org/10.24432/C5XW20.
License (Creative Commons Attribution 4.0) : https://creativecommons.org/licenses/by/4.0/legalcode

### EUR USD 2002-2020 Forex Data

Data : https://www.kaggle.com/datasets/imetomi/eur-usd-forex-pair-historical-data-2002-2019?select=eurusd_minute.csv
License (AGPL-3.0): https://www.gnu.org/licenses/agpl-3.0.html

### Reference

- https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.read_csv.html
- https://scikit-learn.org/stable/modules/compose.html
- https://scikit-learn.org/stable/auto_examples/ensemble/plot_gradient_boosting_categorical.html
- https://scikit-learn.org/stable/auto_examples/classification/plot_classifier_comparison.html
- https://scikit-learn.org/stable/modules/metrics.html
- https://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.text.CountVectorizer.html
- https://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.DictVectorizer.html
- https://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.text.TfidfTransformer.html#sklearn.feature_extraction.text.TfidfTransformer
- https://scikit-learn.org/stable/modules/generated/sklearn.feature_extraction.text.TfidfVectorizer.html

0 comments on commit 63769d9

Please sign in to comment.