Skip to content

Commit 5e7ddcd

Browse files
committed
feat: add README
1 parent 1861027 commit 5e7ddcd

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# DCR Documentation Examples
2+
3+
このリポジトリは、AutoPrivacy DCR(Data Clean Room)のチュートリアルとDCR上で実行する関数の実装例を提供します。
4+
5+
## 概要
6+
7+
AutoPrivacy DCRは、複数のテナント間で安全にデータを共有し、プライバシーを保護しながらデータ分析を実行するためのプラットフォームです。このリポジトリには、チュートリアルとDCR上で実行する関数の実装例が含まれています。
8+
9+
## プロジェクト構成
10+
11+
```
12+
dcr-docs-examples/
13+
├── functions/ # DCR上で実行可能な関数群
14+
│ └── function_name/ # 各関数ディレクトリ
15+
│ ├── function/ # 関数本体とパッケージ
16+
│ ├── inputs/ # 入力データディレクトリ
17+
│ └── outputs/ # 出力データディレクトリ
18+
└── notebooks/ # Jupyter Notebookとドキュメント
19+
├── img/ # 画像ファイル
20+
├── mmd/ # Mermaidファイル
21+
└── tutorial/ # チュートリアル
22+
```
23+
24+
## 利用可能な関数
25+
26+
`functions/`ディレクトリには、DCR上で実行可能な関数の実装例が含まれています。各関数の詳細については、対応するディレクトリ内のドキュメントを参照してください。
27+
28+
## チュートリアル
29+
30+
`notebooks/tutorial/basic_apc_cli_tutorial.ipynb` には、APC-CLIを使用してDCR上で関数を実行するための基本的なフローがJupyter Notebookとして含まれています。
31+
32+
## セットアップ
33+
34+
1. リポジトリをクローン:
35+
```bash
36+
git clone https://github.com/acompany-develop/dcr-docs-examples.git
37+
cd dcr-docs-examples
38+
```
39+
40+
2. チュートリアルを開始:
41+
`notebooks/tutorial/basic_apc_cli_tutorial.ipynb` を開いて、手順に従って実行してください。
42+
43+
## ドキュメント
44+
45+
詳細なドキュメントは以下を参照してください:
46+
- [AutoPrivacy Cloud DCR ユーザーガイド](https://acompany-develop.github.io/autoprivacy-cloud/apc-dcr/)
47+
- [APC-CLI リファレンス](https://acompany-develop.github.io/autoprivacy-cloud/apc-cli/)

0 commit comments

Comments
 (0)