Skip to content

Latest commit

 

History

History
164 lines (92 loc) · 5.9 KB

README_PYPI.md

File metadata and controls

164 lines (92 loc) · 5.9 KB
ZetaForge Logo

PyPI version Discord X Badge YouTube Channel

Open source AI platform for rapid development of advanced AI and AGI pipelines.

Project Image

🔥 Why ZetaForge?

ZetaForge is an AI platform designed to accelerate the development and deployment of advanced AI solutions. It allows users to assemble reusable, customizable, and containerized Blocks into highly visual AI Pipelines, enabling rapid experimentation and collaboration.

  • Language Agnostic: Work with AI technologies in any programming language.
  • Dynamic: Easily modify and update AI pipelines with new or improved components.
  • Full Code Accessibility: Dive into the code whenever needed while enjoying a user-friendly interface.
  • Community and Sharing: Utilize community-driven blocks and pipelines, and share your own creations.

⭐ Support us by starring this repo.

📰 Breaking News

We've launched the first release of ZetaForge! Start building AI pipelines with our core features.

Expect regular updates with new enhancements.

👁 Watch this repo to stay in the loop about changes and updates.

Getting Started

Installation You can install ZetaForge Python Package through pip by running the following command in your terminal:

pip install zetaforge

Or, you can clone the ZetaForge GitHub repository and install from source by running:

git clone https://github.com/zetane/zetaforge
cd zetaforge
pip install .

Install Docker Desktop and Enable Kubernetes

You need to install Docker Desktop or any other container runtime that includes Kubernetes integration. Follow the instructions to install Docker Desktop from their official website. You will need to enable Kubernetes to use ZetaForge.

Note: We recommend OrbStack to macOS users for efficiency and performance reasons.

Launch ZetaForge

To launch ZetaForge, run the following command after installing via pip:

zetaforge launch

This will set up the correct services in Kubernetes, check that they are running, and then launch ZetaForge.

If something goes wrong, you can run:

zetaforge setup

to reconfigure the container services.

To teardown and remove the Kubernetes services, you can run:

zetaforge teardown

Run your First Pipeline

Demo Pipeline

To experience ZetaForge in action, start by dragging and dropping a core pipeline, such as the "Canny Edge Pipeline," from the Core Pipelines Library into your workspace. Once the pipeline is loaded, click the "Run" button to see the magic happen!

Documentation

Explore our official documentation for a guide on using ZetaForge. Learn how to create your own ZetaForge blocks, assemble custom pipelines, and more. You'll also find tutorials and best practices to enhance your ZetaForge experience.

Pipeline Gallery

Visualize Multidimensional Numpy Arrays

Pipeline Screenshot Numpy

Integrate Popular GitHub Repos in AI Pipeline (LAVIS and Open-CD)

Pipeline Screenshot GitHub

Use Three.js Visualization Blocks

Pipeline Screenshot Three.js

Share a Pipeline

To share a pipeline with your team, follow these steps:

  1. Save: Go to File -> Save or Save As, choose a target folder, and name your pipeline.
  2. Package and Send: Zip the saved folder, which contains all necessary files, and share it with your team.
  3. Load and Run: Team members can unzip the folder, load the pipeline via File -> Load -> Pipeline, and click Run to replicate the results.

This streamlined process ensures easy sharing and consistent results across your team.

Contributing

ZetaForge is under active development. We welcome contributions from the community to make our project even better!

Before contributing, please take a moment to review our Contribution Guide to see our guidelines. Whether it's improving documentations, reporting bugs, suggesting new features, or submitting code changes, your contributions help us improve the project for everyone.

License

Contact