Skip to content

docs: add Japanese readme #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
e06084 merged 3 commits into from
May 28, 2025
Merged

docs: add Japanese readme #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7b352cd
docs: update MCP readme
e06084 May 28, 2025
7e1a029
docs: add ja readme
e06084 May 28, 2025
b45cf68
x
e06084 May 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,50 @@
__pycache__/
*.egg-info/
*.tar
*.tar.gz
*.zip
venv*/
envs/
slurm_logs/
local_tests/

__pycache__
*.log
*.pyc
.vscode
debug/
*.ipynb
.idea
.python-version

# vscode history
.history

.DS_Store
.env

bad_words/
bak/

app/tests/*
temp/
tmp/
tmp
.vscode
.vscode/
ocr_demo
.coveragerc


# sphinx docs
_build/


output/
**/temp.py

# coverage file
.coverage*
coverage.xml

llm_web_kit.egg-info/*
.llm-web-kit.jsonc
.llm-web-kit-pageclassify.jsonc
25 changes: 17 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

<div align="center">

[English](README.md) · [简体中文](README_zh-CN.md)
[English](README.md) · [简体中文](README_zh-CN.md) · [日本語](README_ja.md)

</div>

Expand Down Expand Up @@ -146,6 +146,22 @@ Where `output_directory` contains the evaluation results with a `summary.json` f
## Online Demo
Try Dingo on our online demo: [(Hugging Face)🤗](https://huggingface.co/spaces/DataEval/dingo)


# MCP Server

Dingo includes an experimental Model Context Protocol (MCP) server. For details on running the server and integrating it with clients like Cursor, please see the dedicated documentation:

[English](README_mcp.md) · [简体中文](README_mcp_zh-CN.md) · [日本語](README_mcp_ja.md)

## Video Demonstration

To help you get started quickly with Dingo MCP, we've created a video walkthrough:

https://github.com/user-attachments/assets/aca26f4c-3f2e-445e-9ef9-9331c4d7a37b

This video demonstrates step-by-step how to use Dingo MCP server with Cursor.


# Data Quality Metrics

Dingo classifies data quality issues into 7 dimensions of Quality Metrics. Each dimension can be evaluated using both rule-based methods and LLM-based prompts:
Expand Down Expand Up @@ -382,13 +398,6 @@ Example summary:
```


# MCP Server (Experimental)

Dingo includes an experimental Model Context Protocol (MCP) server. For details on running the server and integrating it with clients like Cursor, please see the dedicated documentation:

[**Dingo MCP Server Documentation (README_mcp.md)**](README_mcp.md)


# Research & Publications

## Research Powered by Dingo
Expand Down
Loading