Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

# JiaoZiFS (JZFS)
# JZFS
A version control file system for data linage & data collaboration.

<p align="left">
Expand All @@ -9,15 +8,15 @@ A version control file system for data linage & data collaboration.
<br/>
</p>

<a href="https://github.com/GitDataAI/jiaozifs"><img src="https://github.com/GitDataAI/jiaozifs/blob/main/docs/logo/jiaozifs.png?raw=true" width="100" /></a>
<a href="https://github.com/GitDataAI/jzfs"><img src="https://github.com/GitDataAI/jzfs/blob/main/docs/logo/jiaozifs.png?raw=true" width="100" /></a>

----
JiaoZiFS is an industry-leading **Data-Centric Version Control** File System, helps ensure Responsible AI Engineering by improving **Data Versioning**, **Provenance**, and **Reproducibility**.
JZFS is an industry-leading **Data-Centric Version Control** File System, helps ensure Responsible AI Engineering by improving **Data Versioning**, **Provenance**, and **Reproducibility**.

Note:
* The name JiaoZi pays tribute to the world's earliest paper money: [Song Dynasty JiaoZi](https://en.wikipedia.org/wiki/Jiaozi_(currency)).
* JiaoZiFS is yet another implementation of [IPFS (InterPlanetary File System)](https://ipfs.tech/) as JiaoZiFS will be compatible with the [implementation requirements](https://specs.ipfs.tech/architecture/principles/#ipfs-implementation-requirements) of IPFS.
* As a filesystem of data versioning at scale, although JiaoZiFS is built for machine learning, It has a wide range of use scenarios (refer A Universe of Uses) and can be seamlessly integrated into all your data stack.
* The name JZFS pays tribute to the world's earliest paper money: [Song Dynasty JiaoZi](https://en.wikipedia.org/wiki/Jiaozi_(currency)).
* JZFS is yet another implementation of [IPFS (InterPlanetary File System)](https://ipfs.tech/) as JZFS will be compatible with the [implementation requirements](https://specs.ipfs.tech/architecture/principles/#ipfs-implementation-requirements) of IPFS.
* As a filesystem of data versioning at scale, although JZFS is built for machine learning, It has a wide range of use scenarios (refer A Universe of Uses) and can be seamlessly integrated into all your data stack.

Data-centric AI is about the practice of iterating and collaborating on data, used to build AI systems, programmatically. Machine learning pioneer Andrew Ng [argues that focusing on the quality of data fueling AI systems will help unlock its full power](https://youtu.be/TU6u_T-s68Y).

Expand All @@ -35,15 +34,15 @@ In production systems with machine learning components, updates and experiments

#### Requirement

1. To build JiaoZiFS, you need a working installation of [Go 1.22.0 or higher](https://golang.org/dl/)
2. JiaoZiFS use postgres to store running data, you can install at [postgres install installation guide](https://www.postgresql.org/docs/current/installation.html)
1. To build JZFS, you need a working installation of [Go 1.22.0 or higher](https://golang.org/dl/)
2. JZFS use postgres to store running data, you can install at [postgres install installation guide](https://www.postgresql.org/docs/current/installation.html)

#### Build And Running

1. clone and build
```bash
git clone https://github.com/GitDataAI/jiaozifs.git
cd jiaozifs
git clone https://github.com/GitDataAI/jzfs.git
cd jzfs
make build
```

Expand All @@ -62,16 +61,16 @@ docker run -v <data>:/app -p 34913:34913 gitdatateam/jzfs:latest --db "postgres
```
#### Cloud

[Try without installing](https://cloud.jiaozifs.com)
[Try without installing](https://console.gitdata.ai)

Note: storage config for IPFS backend storage as you create a new repository in JiaoZiFS UI.
Note: storage config for IPFS backend storage as you create a new repository in JZFS Console.

```
{"type":"ipfs","ipfs":{"url":"/dns/kubo-service.ipfs.svc.cluster.local/tcp/5001"}}
```

#### Examples
Build AL/ML pipeline over JiaoZiFS
Build AL/ML pipeline over JZFS
[Face detection and recognition inference pipeline](https://colab.research.google.com/drive/1wsv-KMxTdsCLZ64eLq4W1MTfspid-vv6?usp=sharing)

----
Expand Down Expand Up @@ -100,6 +99,6 @@ Build AL/ML pipeline over JiaoZiFS
----
### License

Dual-licensed under [MIT](https://github.com/GitDataAI/jiaozifs/blob/main/LICENSE-MIT) + [Apache 2.0](https://github.com/GitDataAI/jiaozifs/blob/main/LICENSE-APACHE)
Dual-licensed under [MIT](https://github.com/GitDataAI/jzfs/blob/main/LICENSE-MIT) + [Apache 2.0](https://github.com/GitDataAI/jzfs/blob/main/LICENSE-APACHE)


9 changes: 5 additions & 4 deletions api/resp.gen.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading