Merge pull request #1 from Infotrend-Inc/initialrelease

25a01

Author: mmartial

.WiP/Home-Credit-Default-Risk-Recognition/Home Credit Risk Notebook.ipynb

@@ -1,18 +1,37 @@
-# Home Credit Default Risk Recognition
+<h1>Home Credit Default Risk Recognition</h1>
 
-## Original Author
+In `.WiP` folder: `featuretools` is not maintained.
+
+- [1. Project Details](#1-project-details)
+  - [1.1. Original Author](#11-original-author)
+  - [1.2. Original GitHub Link](#12-original-github-link)
+  - [1.3. Description of Project](#13-description-of-project)
+  - [1.4. Required Datasets](#14-required-datasets)
+    - [1.4.1. How to Set Up the Dataset](#141-how-to-set-up-the-dataset)
+  - [1.5. Expected Packages and Resource Requirements](#15-expected-packages-and-resource-requirements)
+- [2. CoreAI Setup](#2-coreai-setup)
+  - [2.1. Stop CoreAI](#21-stop-coreai)
+- [3. Detailed Setup](#3-detailed-setup)
+  - [3.1. How To Use](#31-how-to-use)
+    - [3.1.1. Important Note](#311-important-note)
+  - [3.2. Troubleshooting](#32-troubleshooting)
+
+
+# 1. Project Details
+
+## 1.1. Original Author
 
 **GitHub Profile**: [Abhishek Bihani](https://github.com/abhishekdbihani)
 
-## Original GitHub Link
+## 1.2. Original GitHub Link
 
 [Home Credit Default Risk Recognition Repository](https://github.com/abhishekdbihani/Home-Credit-Default-Risk-Recognition/tree/master)
 
-## Description of Project
+## 1.3. Description of Project
 
 This project aims to predict the ability of applicants to repay a loan based on historical financial data. Utilizing machine learning techniques, the model assesses the creditworthiness of potential borrowers, enhancing the decision-making process for granting loans. This solution is particularly beneficial in providing an opportunity for people who struggle to get loans due to insufficient credit history.
 
-## Required Datasets
+## 1.4. Required Datasets
 
 The datasets used in this project are detailed financial records provided by Home Credit, each describing a different aspect of the applicant's financial history:
 
@@ -25,14 +44,14 @@ The datasets used in this project are detailed financial records provided by Hom
 - **installments_payments.csv**: Repayment history for previously disbursed credits in Home Credit.
 - **HomeCredit_columns_description.csv**: Descriptions for the columns in the various data files.
 
-### How to Set Up the Dataset
+### 1.4.1. How to Set Up the Dataset
 1. Create a `data` folder in your project directory.
 2. Download the datasets from [Home Credit Dataset](https://www.kaggle.com/c/home-credit-default-risk/data) on Kaggle.
    - Note: You will need to log in to Kaggle to access and download these files due to the special rules set by the competition.
 3. Place the downloaded files into the `data` folder.
 
 
-## Expected Packages and Resource Requirements
+## 1.5. Expected Packages and Resource Requirements
 
 **Python Packages**:
 - pydash
@@ -44,15 +63,39 @@ The datasets used in this project are detailed financial records provided by Hom
 **Resource Requirements**:
 - CPU
 
-## How To Use
+# 2. CoreAI Setup
+
+From the folder where this `README.md` is, run:
+
+```bash
+# Run one of the following commands:
+
+# podman command
+podman run --rm -it --userns=keep-id --device nvidia.com/gpu=all -e WANTED_UID=`id -u` -e WANTED_GID=`id -g` -e CoreAI_VERBOSE="yes" -v `pwd`:/iti -p 8888:8888 docker.io/infotrend/coreai:latest  /run_jupyter.sh
+
+# docker command
+docker run --rm -it --runtime=nvidia --gpus all -e WANTED_UID=`id -u` -e WANTED_GID=`id -g` -e CoreAI_VERBOSE="yes" -v `pwd`:/iti -p 8888:8888 infotrend/coreai:latest  /run_jupyter.sh
+```
+
+Follow the instructions in the notebook `Home-Credit-Default-Risk-Recognition.ipynb`.
+
+## 2.1. Stop CoreAI
+
+You can stop the Notebook by using the `File -> Shutdown` option.
+
+Alternatively, you can stop the container by pressing `Ctrl + C` in the terminal where the container is running.
+
+# 3. Detailed Setup
+
+## 3.1. How To Use
 
 1. **Setup Environment**:
    - Clone the repository or download the specific project files.
    - Ensure Python 3.x is installed.
 
 2. **Install Required Packages**:
 
-   - To enhance the functionality of the CTPO environment, you may need to install some libraries not pre-installed but required for this notebook. Follow these steps to install the necessary libraries from the `requirements.txt` file:
+   - To enhance the functionality of the CoreAI environment, you may need to install some libraries not pre-installed but required for this notebook. Follow these steps to install the necessary libraries from the `requirements.txt` file:
 
    **2.1 Create and Activate the Virtual Environment:**
 
@@ -75,7 +118,7 @@ The datasets used in this project are detailed financial records provided by Hom
    ```
    !. ./myvenv/bin/activate; pip install -r requirements.txt
    ```
-### Important Note
+### 3.1.1. Important Note
 
 It is crucial to load the new "myvenv" kernel for the notebook to work correctly. If the new "myvenv" kernel is not loaded, the required libraries and environment settings will not be applied, and the notebook will not function as expected.
 
@@ -86,7 +129,7 @@ It is crucial to load the new "myvenv" kernel for the notebook to work correctly
 4. **Model Usage**:
    - **Predictive Capability**: The trained models can be used to predict default risk on new customer data, thereby helping financial institutions make informed loan approval decisions.
 
-## Troubleshooting
+## 3.2. Troubleshooting
 - Ensure all required packages from `requirements.txt` are properly installed.
 - Verify that dataset paths in the notebook match the location of the downloaded files.
 - Check Python version compatibility with the packages used.

Home-Credit-Default-Risk-Recognition/Readme.md renamed to .WiP/Home-Credit-Default-Risk-Recognition/Readme.md

@@ -1,7 +1,6 @@
 pydash
-featuretools
 lightgbm
 hyperopt
-featuretools==0.16
 seaborn
 xgboost
+featuretools

Home-Credit-Default-Risk-Recognition/requirements.txt renamed to .WiP/Home-Credit-Default-Risk-Recognition/requirements.txt

@@ -40,7 +40,7 @@
     "\n",
     "2. **Install Required Packages**:\n",
     "\n",
-    "   - To enhance the functionality of the CTPO environment, you may need to install some libraries not pre-installed but required for this notebook. Follow these steps to install the necessary libraries from the `requirements.txt` file:\n",
+    "   - To enhance the functionality of the CoreAI environment, you may need to install some libraries not pre-installed but required for this notebook. Follow these steps to install the necessary libraries from the `requirements.txt` file:\n",
     "\n",
     "   **2.1 Create and Activate the Virtual Environment:**\n",
     "   \n",
@@ -51,8 +51,7 @@
     "   Execute the following commands to create and activate the virtual environment:\n",
     "   \n",
     "   ```\n",
-    "   bash\n",
-    "   python3 -m venv --system-site-packages myvenv #myvenv is name of virtual environment you can change it\n",
+    "   python3 -m venv --system-site-packages myvenv\n",
     "   source myvenv/bin/activate\n",
     "   pip3 install ipykernel\n",
     "   python -m ipykernel install --user --name=myvenv --display-name=\"Python (myvenv)\"\n",
@@ -463,9 +462,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python (openvoicevenv)",
+   "display_name": "Python (myvenv)",
    "language": "python",
-   "name": "openvoicevenv"
+   "name": "myvenv"
   },
   "language_info": {
    "codemirror_mode": {
@@ -477,7 +476,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.12"
+   "version": "3.12.3"
   }
  },
  "nbformat": 4,

OpenVoiceClone/demo.ipynb renamed to .WiP/OpenVoiceClone/OpenVoiceClone.ipynb

@@ -1,50 +1,94 @@
-# OpenVoice: Advanced Voice Cloning and Synthesis
-
-## Project Overview
+# 1. OpenVoice: Advanced Voice Cloning and Synthesis
+
+In `.WiP` due to missing library. Will investigate further.
+
+- [1. OpenVoice: Advanced Voice Cloning and Synthesis](#1-openvoice-advanced-voice-cloning-and-synthesis)
+- [2. Project Overview](#2-project-overview)
+  - [2.1. Original GitHub Link](#21-original-github-link)
+  - [2.2. Voice Translation Widgets](#22-voice-translation-widgets)
+    - [2.2.1. Features](#221-features)
+    - [2.2.2. Usage](#222-usage)
+- [3. CoreAI Setup](#3-coreai-setup)
+  - [3.1. Stop CoreAI](#31-stop-coreai)
+- [4. Detailed Setup](#4-detailed-setup)
+  - [4.1. System Requirements](#41-system-requirements)
+  - [4.2. Setup and Installation](#42-setup-and-installation)
+  - [4.3. How To Use](#43-how-to-use)
+  - [4.4. Model Preparation](#44-model-preparation)
+  - [4.5. Run the Notebook:](#45-run-the-notebook)
+  - [4.6. Troubleshooting](#46-troubleshooting)
+    - [4.6.1. Common Issues and Fixes](#461-common-issues-and-fixes)
+
+
+# 2. Project Overview
 
 OpenVoice is a cutting-edge project dedicated to the development of voice cloning and speech synthesis technologies. This repository hosts the tools and models necessary for implementing state-of-the-art voice cloning capabilities, enabling users to create lifelike synthetic voices from audio samples.
 
-## Original GitHub Link
+## 2.1. Original GitHub Link
 
 [OpenVoice Project Repository](https://github.com/myshell-ai/OpenVoice)
 
 
-## Voice Translation Widgets
+## 2.2. Voice Translation Widgets
 
 This application provides a user-friendly interface for voice translation. Below are the features available:
 
-### Features
+### 2.2.1. Features
 
 1. **Voice Upload**: Users can upload their voice recordings in MP3 format.
 
 2. **Language Selection**: A dropdown menu allows users to select the language of the text to which the uploaded voice will be translated.
 
 3. **Text Input Box**: Users can input or edit the text that will be translated into the selected language using the uploaded voice.
 
-### Usage
+### 2.2.2. Usage
 
 - **Uploading Voice**: Click on the 'Upload' button and select an MP3 file from your device.
 - **Selecting Language**: Use the dropdown to choose the target language for translation.
 - **Entering Text**: Type into the text box the text you want to use for translation.
 
 This application is designed to be intuitive and easy to use, ensuring that users can quickly translate voices with minimal effort.
 
-## System Requirements
+# 3. CoreAI Setup
+
+From the folder where this `README.md` is, run:
+
+```bash
+# Run one of the following commands:
+
+# podman command
+podman run --rm -it --userns=keep-id --device nvidia.com/gpu=all -e WANTED_UID=`id -u` -e WANTED_GID=`id -g` -e CoreAI_VERBOSE="yes" -v `pwd`:/iti -p 8888:8888 docker.io/infotrend/coreai:latest  /run_jupyter.sh
+
+# docker command
+docker run --rm -it --runtime=nvidia --gpus all -e WANTED_UID=`id -u` -e WANTED_GID=`id -g` -e CoreAI_VERBOSE="yes" -v `pwd`:/iti -p 8888:8888 infotrend/coreai:latest  /run_jupyter.sh
+```
+
+Follow the instructions in the notebook `OpenVoiceClone.ipynb`.
+
+## 3.1. Stop CoreAI
+
+You can stop the Notebook by using the `File -> Shutdown` option.
+
+Alternatively, you can stop the container by pressing `Ctrl + C` in the terminal where the container is running.
+
+# 4. Detailed Setup
+
+## 4.1. System Requirements
 
 - **Python 3.x**: Ensure Python 3.x is installed.
 - **Operating System**: Linux or macOS (for complete compatibility with all tools and scripts).
 
-## Setup and Installation
+## 4.2. Setup and Installation
 
-## How To Use
+## 4.3. How To Use
 
 1. **Setup Environment**:
    - Clone the repository or download the specific project files.
    - Ensure Python 3.x is installed.
 
 2. **Install Required Packages**:
 
-   - To enhance the functionality of the CTPO environment, you may need to install some libraries not pre-installed but required for this notebook. Follow these steps to install the necessary libraries from the `requirements.txt` file:
+   - To enhance the functionality of the CoreAI environment, you may need to install some libraries not pre-installed but required for this notebook. Follow these steps to install the necessary libraries from the `requirements.txt` file:
 
    **2.1 Create and Activate the Virtual Environment:**
 
@@ -70,7 +114,7 @@ This application is designed to be intuitive and easy to use, ensuring that user
    !. ./myvenv/bin/activate; pip install -r requirements.txt
    ```
 
-## Model Preparation
+## 4.4. Model Preparation
 Download and prepare the model data:
 
 1. Create a directory for model checkpoints:
@@ -83,13 +127,13 @@ Download and prepare the model data:
     unzip checkpoints_v2_0417.zip -d checkpoints_v2
     ```
    
-## Run the Notebook:
+## 4.5. Run the Notebook:
 - Open the `demo.ipynb` notebook in a Jupyter environment.
 -  Follow the instructions within the notebook, executing the code cells in sequence. Each cell includes comments explaining the purpose of the code, which will guide you through the demo process.
 - Make sure to read any embedded instructions or comments carefully to maximize your understanding and troubleshooting any issues that may arise.
 
-## Troubleshooting
-### Common Issues and Fixes
+## 4.6. Troubleshooting
+### 4.6.1. Common Issues and Fixes
 CUDA Library Error: If you encounter an error related to libcublas.so.11, create a symbolic link to the newer version:
     ```
     ln -s /usr/local/cuda/lib64/libcublas.so.12 /usr/local/cuda/lib64/libcublas.so.11

OpenVoiceClone/openvoice/__init__.py renamed to .WiP/OpenVoiceClone/openvoice/__init__.py

@@ -0,0 +1,20 @@
+librosa
+faster-whisper
+pydub
+wavmark
+eng_to_ipa
+inflect
+unidecode
+whisper-timestamped
+openai
+python-dotenv
+pypinyin
+cn2an
+jieba
+gradio
+langid
+sounddevice
+mecab-python3
+git+https://github.com/myshell-ai/MeloTTS.git
+unidic
+#melotts

OpenVoiceClone/openvoice/api.py renamed to .WiP/OpenVoiceClone/openvoice/api.py

@@ -0,0 +1,11 @@
+# About
+
+Existing projects that are have been tested with CoreAI but found not functional currently or are still in the process of being tested.
+
+A note in the header of individual README.md files in the subfolders will detail the issues found.
+
+| Domain | Project Name | Link to Directory |
+| --- | --- | --- |
+| Data Science | Home Credit Default Risk Recognition | [Home-Credit-Default-Risk-Recognition](https://github.com/Infotrend-Inc/CoreAI-DemoProjects/tree/main/.WiP/Home-Credit-Default-Risk-Recognition) |
+| Natural Language Processing | Open Voice Clone | [OpenVoiceClone](https://github.com/Infotrend-Inc/CoreAI-DemoProjects/tree/main/.WiP/OpenVoiceClone) |
+| Natural Language Processing | Skimming Literature | [SkimLit](https://github.com/Infotrend-Inc/CoreAI-DemoProjects/tree/main/.WiP/SkimLit) |