Metadata-Version: 2.1
Name: labelu-ml
Version: 0.1.0
Summary: 
Author: pengjinhu
Author-email: pengjinhu@pjlab.org.cn
Requires-Python: >=3.7,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: appdirs (>=1.4.4,<2.0.0)
Requires-Dist: fastapi (>=0.88.0,<0.89.0)
Requires-Dist: loguru (>=0.6.0,<0.7.0)
Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
Requires-Dist: uvicorn (>=0.20.0,<0.21.0)
Description-Content-Type: text/markdown

# Introduction
## Quickstart


1. Setup environment
    
    ```bash
    conda create -n labelu-ml python=3.7
    conda activate labelu-ml
    ```
   
2. Install labelu-ml
   ```bash
   pip install labelu-ml
   ```

3. Initialize an ML application based on an example path:
   ```bash
   labelu-ml init my_ml_app --path labelu_ml/examples/the_simplest_app

   pip install -r my_ml_app/requirements.txt
   ```

4. Start ML application server
   ```bash
   labelu-ml start my_ml_app
   ```

## Usage

### Command line
```
$ labelu-ml --help
                                                                                                                                                     
 Usage: labelu-ml [OPTIONS] COMMAND [ARGS]...                                                                                                        
                                                                                                                                                     
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion          Install completion for the current shell.                                                                           │
│ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                    │
│ --help                        Show this message and exit.                                                                                         │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ init                  Initailize an ML app from a example.                                                                                        │
│ start                 Start ML app server.                                                                                                        │
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

```
