---
library_name: transformers
license: mit
datasets:
- wolf4032/token-classification-japanese-search-local-cuisine
language:
- ja
metrics:
- f1: 0.9961977186311787
- accuracy: 0.9995689655172414
- precision: 0.9940978077571669
- recall: 0.9983065198983911
pipeline_tag: token-classification
widget:
- text: "北海道のジャガイモを使った冬の野菜料理を教えてください"
- text: "牛タンを使った、宮城県の肉料理はありますか？"
- text: "野菜料理で、愛知県で食べられる、人参を使った料理は？"
---

# Model Card for Model ID

料理を検索するための質問文から、検索検索用キーワードである固有表現を抽出します



## Model Details

### Model Description

例えば、「東京の肉料理で、春に食べられる、鶏肉を使った料理を教えてください」という文章を入力すると、

「東京　→　都道府県/地方(AREA)」　「肉料理　→　種類(TYPE)」　「春　→　季節(SZN)」　「鶏肉　→　食材(INGR)」

のように、固有表現を抽出します

抽出対象は、AREA、TYPE、SZN、INGRの４つです

- **Language(s) (NLP):** 日本語
- **License:** mit
- **Finetuned from model:** [tohoku-nlp/bert-base-japanese-v2](https://huggingface.co/tohoku-nlp/bert-base-japanese-v2)

### Model Sources

<!-- Provide the basic links for the model. -->

- **Repository:** [wolf4032/nlp-token-classification](https://github.com/wolf4032/nlp-token-classification)
  - データセット、言語モデル、アプリの作成に使ったコードが掲載されています
- **Documentation:** [Qiita](https://qiita.com/wolf4032/private/9dd7423c706fa86bf005)
- **Demo:** [wolf4032/japanese-token-classification-search-local-cuisine](https://huggingface.co/spaces/wolf4032/japanese-token-classification-search-local-cuisine)

## How to Get Started with the Model

Google Colaboratoryの場合

```python
!pip install transformers fugashi ipadic
!pip install unidic-lite

from transformers import BertJapaneseTokenizer, BertForTokenClassification
from transformers import pipeline

model_name = 'wolf4032/bert-japanese-token-classification-search-local-cuisine'

model = BertForTokenClassification.from_pretrained(model_name)
tokenizer = BertJapaneseTokenizer.from_pretrained(model_name)

ner_pipeline = pipeline(
    'token-classification',
    model=model,
    tokenizer=tokenizer,
    aggregation_strategy='simple'
)

input = '東京の肉料理で、春に食べられる、鶏肉を使った料理を教えてください'
ner_pipeline(input)
```

## Training Details

### Training Data

[wolf4032/token-classification-japanese-search-local-cuisine](https://huggingface.co/datasets/wolf4032/token-classification-japanese-search-local-cuisine)

## Evaluation

<!-- This section describes the evaluation protocols and provides the results. -->

### Testing Data, Factors & Metrics

#### Testing Data

[wolf4032/token-classification-japanese-search-local-cuisine](https://huggingface.co/datasets/wolf4032/token-classification-japanese-search-local-cuisine)

#### Metrics

- F1 Score: 調和平均に基づくメトリクスで、精度と再現率のバランスを示します。
- Accuracy: モデルが正しく予測したインスタンスの割合を示します。
- Precision: モデルが真と予測したもののうち、実際に真であったものの割合を示します。
- Recall: 実際に真であるもののうち、モデルが真と予測したものの割合を示します。

### Results

- f1: 0.9961977186311787
- accuracy: 0.9995689655172414
- precision: 0.9940978077571669
- recall: 0.9983065198983911