Skip to main content

Define a personnal app to deploy on DeepChain.bio

Project description

PyPI License Python 3.7 Code style: black Dependencies

Table of contents

deepchain-apps package documentation

This Package provide a cli for creating a personnal app to deploy on the DeepChain platform. More informations on app To leverage the apps capability, take a look at the bio-transformers and bio-datasets package, which provide functionnality to download biological dataset and easily use pre-trained transformers.

1. Installation

It is recommended to work with conda environnements in order to manage the specific dependencies of the package.

  conda create --name deepchain-env python=3.7 -y
  conda activate deepchain-env
  pip install deepchain-apps

2. CLI commands

The CLI provides 4 main commands:

  • login : you need to supply the token provide on the plateform (PAT: personnal access token).

    deepchain login
    
  • create : create a folder with a template app file

    deepchain create my_application
    
  • deploy : the code and checkpoint are deployed on the plateform, you can select your app in the interface on the plateform.

    • with checkpoint upload

      deepchain deploy my_application --checkpoint
      
    • Only the code

      deepchain deploy my_application
      
  • apps :

    • Get info on all local/upload apps

      deepchain apps --infos
      
    • Remove all local apps (files & config):

      deepchain apps --reset
      
    • Remove a specific application (files & config):

      deepchain apps --delete my_application
      

How generate token to login deepchain?

If you want to deploy biology app on deepchain, you should first create a personal account on deepchain and go to the user profile section. As you can see below, you will be able to generate a PAT (personal access token) that you can use with the CLI command:

deepchain login

3. Getting started with App

.
├── README.md # explain how to create an app
├── __init__.py # __init__ file to create python module
├── checkpoint
│   ├── __init__.py
│   └── Optionnal : model.pt # optional: model to be used in app must be placed there
├── examples
│   ├── app_with_checkpoint.py # example: app example with checkpoint   └── torch_classifier.py # example: show how to train a neural network with pre-trained embeddings
└── src
    ├── DESC.md # Desciption file of the application
    ├── __init__.py
    ├── app.py # main application script. Main class must be named App.
    └── tags.json # file to register the tags on the hub.

License

This source code is licensed under the Apache 2 license found in the LICENSE file in the root directory.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

deepchain-apps-0.1.5.tar.gz (20.9 kB view hashes)

Uploaded Source

Built Distribution

deepchain_apps-0.1.5-py3-none-any.whl (28.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page