Skip to content

masakiaota/Layered-Span-Studio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

253 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Layered Span Studio

Languages: English / 中文

Layered Span Studio は、文字列の任意区間に対して、重なり合う複数ラベルを同時に管理する作業に最適化されたアノテーションツールである。主な特徴は次の通り。

  • 重なり合うラベルを前提にした UI/UX を採用し、複数 span を直感的に編集可能。
  • アノテーションの定義情報や、他の既存アノテーションを即座に確認でき、効率的なアノテーション作業が可能。
  • LLM 連携を見据えたAPIを提供しており、半自動アノテーションの組込が可能。

外観


目次

  1. クイックスタート
  2. リポジトリ構成
  3. リリース運用
  4. 補足事項
  5. License

クイックスタート

クイックスタートとして、デモプロジェクトを読み込む前提で手順をまとめる。

以下は2つのターミナルで並行して実行する想定。

  1. バックエンドを起動する
cd backend
export JWT_SECRET='dev-secret'
uv sync # 初回 / 依存更新時のみ
uv run scripts/create_user.py demo_login_user demo_login_pass # サンプル: 任意のユーザー名とパスワードに置き換え可 / 初回のみ(未作成時)
uv run uvicorn layered_span_studio_backend.main:app --host 127.0.0.1 --port 8000 --reload

JWT_SECRET はログイン後に発行する JWT の署名・検証に使うサーバー側の秘密鍵である。本番環境では十分長くランダムな固定値を設定する。

  1. フロントエンドを起動する
cd ../frontend
npm install # 初回のみ
npm run dev
  1. ブラウザで http://127.0.0.1:5173 (フロントの出力を確認すること) を開き、ログイン後にデモプロジェクトを import する
  • ユーザー名: demo_login_user
  • パスワード: demo_login_pass
  • プロジェクト一覧右上の Import Project から docs/quickstart-demo-project.json を選択
  • import 完了後、作成されたプロジェクトが開くのでアノテーション画面を確認する
  1. すぐ確認できるポイント
  • ドラッグでアノテーションができる。
  • テキストに対して重なり合うラベルを付与することが可能。
  • 右ペインで既存アノテーションや定義情報を確認
  • 選択中の表層テキストに対して、別docにある既存アノテーションを確認可能
  • shortcut で操作が可能 (? ボタンで確認)

自分のデータで始める

自前の文書や annotation データを import 用 JSON に変換したい場合は、docs/import-your-data.md を参照。 英語版は docs/import-your-data-en.md にある。中国語版は docs/import-your-data-zh-CN.md にある。 新しい project を作る import と、既存 project への追記 import の違いもこの手順書で整理している。

リポジトリ構成

  • backend/: サーバ側のAPIとデータ保存、認証、Import/Exportの土台。

  • frontend/: アノテーションUI本体(React + Vite)。

  • docs/: 仕様、設計、運用方針の参照先。

  • 詳細なリリース運用ルールは docs/release.md を参照。

補足事項

本ツールをご利用いただく際には、以下の点にご留意ください。

  • 本ツールを用いて生じたいかなる損害についても、開発者は一切の責任を負いません。
  • 企業での導入も歓迎しています。ご利用いただく場合は、ユースケース・運用要件・改善要望を把握したいため、ぜひご連絡いただけると嬉しいです。 ( aotamasakimail (あっと) gmail.com )
  • IssueやPRも歓迎しています。

License

Licensed under the Apache License, Version 2.0. See LICENSE for details.

About

文字列の任意区間に対して、重なり合う複数ラベルを同時に管理する作業に最適化されたアノテーションツール

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors