nncls

README

nncls

Classification using Neural Network

requirement

• Tensorflow
• python3
• golang

Documentation

Overview

Package nncls : NN による分類器のパッケージ Python で学習したモデルデータを使用

Index

• func Init(c Config) (err error)
• func MaxIndex(x []float32) (r int)
• func RoundList(x []float32) (r []int)
• func ToOneHot(classID, numClass int) (r []float32, err error)
• type Config
• type MetricsData
  • func NewMetricsData(numClass int) (r *MetricsData)
  • func (md *MetricsData) Accuracy(classID int) (r float32)
  • func (md *MetricsData) Add(classID, pred, answer int)
  • func (md *MetricsData) AddClassID(predClassID, answerClassID int) (err error)
  • func (md *MetricsData) AddLabels(predLabels, answerLabels []int) (err error)
  • func (md *MetricsData) MacroMetrics() (macroPrecision, macroRecall, macroFMeasure, averageAccuracy float32)
  • func (md *MetricsData) MicroMetrics() (microPrecision, microRecall, microFMeasure, overallAccuracy float32)
  • func (md *MetricsData) Precision(classID int) (r float32)
  • func (md *MetricsData) Recall(classID int) (r float32)
  • func (md *MetricsData) Total() (r int)
  • func (md *MetricsData) TotalFN() (r int)
  • func (md *MetricsData) TotalFP() (r int)
  • func (md *MetricsData) TotalTN() (r int)
  • func (md *MetricsData) TotalTP() (r int)
• type Model
  • func LoadModel() (r Model, err error)
  • func (m Model) Classify(testData []float32) (classID int, err error)
  • func (m Model) DumpGraphOperations()
  • func (m Model) MultiLabelClassify(testData []float32, f func([]float32) []int) (classIDs []int, err error)
  • func (m Model) Predict(x []float32) (y []float32, err error)

Functions

func Init

func Init(c Config) (err error)

Init : 初期化

func MaxIndex

func MaxIndex(x []float32) (r int)

MaxIndex : 配列の中で最大値となるインデックス番号を返す関数

func RoundList

func RoundList(x []float32) (r []int)

RoundList : 配列の要素の中で閾値以下は0,閾値超は1となるリストを返す関数

func ToOneHot

func ToOneHot(classID, numClass int) (r []float32, err error)

ToOneHot : スカラー値をクラス数 numClass の one-hot 形式の配列に変換

逆は MaxIndex。

Types

type Config

type Config struct {
	ModelDir   string  // モデルデータのディレクトリ
	InputName  string  // 入力のプレースホルダの名前
	OutputName string  // 出力のプレースホルダの名前
	NumInput   int     // 入力となる特徴量の個数
	Threshold  float32 // ラベル判定の閾値
}

Config : 設定パラメータ

type MetricsData

type MetricsData struct {
	// contains filtered or unexported fields
}

MetricsData : メトリクスを保持するデータ型

func NewMetricsData

func NewMetricsData(numClass int) (r *MetricsData)

NewMetricsData :

func (*MetricsData) Accuracy

func (md *MetricsData) Accuracy(classID int) (r float32)

Accuracy : クラスごとの正解率

func (*MetricsData) Add

func (md *MetricsData) Add(classID, pred, answer int)

Add : クラスごとの予測と回答を追加する

classID --- クラスの識別子
pred --- 予測 (1 or 0) 1:classIDであると予測 / 0:classIDではないと予測
answer --- 回答 (1 or 0) 1:classIDが回答 / 0:classID以外が回答

func (*MetricsData) AddClassID

func (md *MetricsData) AddClassID(predClassID, answerClassID int) (err error)

AddClassID : クラスごとの予測と回答を追加する

predClassID --- 予測したクラス
answerClassID --- 回答となるクラス

func (*MetricsData) AddLabels

func (md *MetricsData) AddLabels(predLabels, answerLabels []int) (err error)

AddLabels : マルチラベルの予測と回答を追加する

predLabels --- 予測したマルチラベル
answerLabels --- 回答となるクラス

func (*MetricsData) MacroMetrics

func (md *MetricsData) MacroMetrics() (macroPrecision, macroRecall, macroFMeasure, averageAccuracy float32)

MacroMetrics : 全体の Macro なメトリクス

func (*MetricsData) MicroMetrics

func (md *MetricsData) MicroMetrics() (microPrecision, microRecall, microFMeasure, overallAccuracy float32)

MicroMetrics : 全体の Micro なメトリクス

func (*MetricsData) Precision

func (md *MetricsData) Precision(classID int) (r float32)

Precision : クラスごとの適合率

func (*MetricsData) Recall

func (md *MetricsData) Recall(classID int) (r float32)

Recall : クラスごとの再現率

func (*MetricsData) Total

func (md *MetricsData) Total() (r int)

Total : 合計値

func (*MetricsData) TotalFN

func (md *MetricsData) TotalFN() (r int)

TotalFN : FNの合計値

func (*MetricsData) TotalFP

func (md *MetricsData) TotalFP() (r int)

TotalFP : FPの合計値

func (*MetricsData) TotalTN

func (md *MetricsData) TotalTN() (r int)

TotalTN : TNの合計値

func (*MetricsData) TotalTP

func (md *MetricsData) TotalTP() (r int)

TotalTP : TPの合計値

type Model

type Model struct {
	// contains filtered or unexported fields
}

Model : モデルデータを保持するデータ型

func LoadModel

func LoadModel() (r Model, err error)

LoadModel : モデルデータの読み込み

func (Model) Classify

func (m Model) Classify(testData []float32) (classID int, err error)

Classify : 分類 In: testData --- 特徴データ Out: classID --- クラスID

func (Model) DumpGraphOperations

func (m Model) DumpGraphOperations()

DumpGraphOperations : モデルデータ内のグラフに含まれるオペレーション名を出力する関数

func (Model) MultiLabelClassify

func (m Model) MultiLabelClassify(testData []float32, f func([]float32) []int) (classIDs []int, err error)

MultiLabelClassify : 分類 In: testData --- 特徴データ Out: classID --- クラスID

func (Model) Predict

func (m Model) Predict(x []float32) (y []float32, err error)

Predict : 分類 In: x --- 特徴データ Out: y --- クラスID(one_hot)