Metadata-Version: 2.1
Name: neucore
Version: 1.0.0
Summary: A package for Ailiverse AI models
Home-page: https://ailiverse.com
Author: Nicholas Chua, Burhan Ul Tayyab
Author-email: Nicholas Chua <nicholas@ailiverse.com>, Burhan Ul Tayyab <burhanultayyab@ailiverse.com>
Project-URL: Homepage, https://github.com/ailiverse/neucore
Project-URL: Bug Tracker, https://github.com/ailiverse/neucore/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.5
Description-Content-Type: text/markdown
License-File: LICENSE


# Table of Contents

1.  [Installation](#orgc64ab88)
2.  [Usage](#org32451d6)

This is the pypi package for Ailiverse AI models


<a id="orgc64ab88"></a>

# Installation
    git clone https://github.com/ailiverse/neucore
    
    cd neucore
    
    pip install .

<a id="org32451d6"></a>

# Usage
The following are the models implemented
-   Image Segmentation
-   Image Classification
-   Deep Fake Detection
-   Text Guided Segmentation

**Note Text Guided Segmentation does not have training or upload functions**

    import neucore
    
    email = YOUR_EMAIL_HERE
    password = YOUR_PASSWORD_HERE
    confirm_password = YOUR_PASSWORD_HERE
    organization = YOUR ORGANIZATION HERE
    
    # sign up 
    authToken = neucore.signUp(email, password, confirm_password, organization)
    
    # Uncomment if your email is already registered, however, you've lost your token
    # authToken = neucore.signIn(email, password)
    
    # defined the model
    model = neucore.Model(authToken, model="Image Segmentation")
    # If you still want to use the same model Id uncomment the following code
    # model = neucore.Model(authToken, modelID = "YOUR_MODELID_HERE", model="Image Segmentation")
    
    model.uploadFile("train.zip", "labelme")
    
    model.train(epochs=1) # By default the number of epochs is 10
    
    results = model.infer("hen.jpg")
    
    print(results)
    
**Note you can use the modelID argument when initalizing the neucore model to if you want to use the previous models**
