Metadata-Version: 2.1
Name: namable_classify
Version: 0.0.2
Home-page: https://github.com/2catycm/NamableClassify
Author: 叶璨铭
Author-email: ycm24@mails.tsinghua.edu.cn
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
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
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastcore
Requires-Dist: decorator
Requires-Dist: pydantic
Requires-Dist: loguru
Requires-Dist: bigmodelvis
Requires-Dist: richuru
Requires-Dist: transformers
Requires-Dist: scikit-learn
Requires-Dist: torch
Requires-Dist: torchvision
Requires-Dist: numpy
Requires-Dist: lightning
Requires-Dist: optuna
Requires-Dist: optuna-integration
Requires-Dist: optuna-dashboard
Requires-Dist: plotly
Requires-Dist: psycopg2-binary
Requires-Dist: sqlalchemy
Requires-Dist: clearml
Requires-Dist: wandb
Requires-Dist: tensorboard
Requires-Dist: mlflow
Requires-Dist: psutil
Requires-Dist: nvgpu
Provides-Extra: dev
Requires-Dist: ipykernel; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: nbdev; extra == "dev"

# NamableClassify


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

> “名可名，非常名。无名，天地之始; 有名，万物之母。” —— 《道德经》

> “The names that are given to the namable, are not the enduring and
> unchanging nature of the namable.
>
> The unnamable (, which is the nature of the namable, ) is considered
> as the beginning of the world;
>
> the namable (names, in contrast), we attribute them to be the mother
> of (guiding us to learn and recognize) all things.” —— “Dao De Jing
> (Classic of the Way and Virtue)”

> “A thing is a thing; not what is said of that thing.” —— “Birdman”

In this library, we are focusing on the Image Classification task, which
requires the AI model to classify images into different preset names
(categories).

We believe this is the beginning how we can train AI models and guide
them to know the world, because as you can see since from the `ImageNet`
competition, the performance of AI models has been improving
significantly, with the rapid development of deep learning techniques,
resulting in the advancement of artificial intelligence.

That’s why we named our library the `NamableClassify`, borrowing the
“Old Master” ’s philosophy.

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

### Install NamableClassify in Development mode

``` sh
# make sure NamableClassify package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to NamableClassify
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/2catycm/NamableClassify):

``` sh
$ pip install git+https://github.com/2catycm/NamableClassify.git
```

or from [conda](https://anaconda.org/2catycm/namable_classify)

``` sh
$ conda install -c 2catycm namable_classify
```

or from [pypi](https://pypi.org/project/namable_classify/)

``` sh
$ pip install namable_classify
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/2catycm/NamableClassify)’s
[pages](https://2catycm.github.io/NamableClassify/). Additionally you
can find package manager specific guidelines on
[conda](https://anaconda.org/2catycm/namable_classify) and
[pypi](https://pypi.org/project/namable_classify/) respectively.

## How to use

Fill me in please! Don’t forget code examples:

``` python
1+1
```

    2
