Skip to content
This repository was archived by the owner on Sep 18, 2024. It is now read-only.

Commit

Permalink
feat: scrub subnet mentions
Browse files Browse the repository at this point in the history
  • Loading branch information
GuiBibeau committed Jun 3, 2024
1 parent bfa7039 commit 5a9ca5b
Show file tree
Hide file tree
Showing 40 changed files with 11 additions and 2,310 deletions.
3 changes: 1 addition & 2 deletions .github/PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,12 @@ Briefly describe the purpose of the pull request and what it aims to achieve. In

### Description

This pull request updates the README to provide a clearer and more comprehensive understanding of Akeru.ai. The enhancements include detailed descriptions of new API features, the Bittensor Subnet integration, and improved section formatting. These updates aim to make the repository more welcoming and informative for new contributors and users.
This pull request updates the README to provide a clearer and more comprehensive understanding of Akeru.ai. The enhancements include detailed descriptions of new API features, and improved section formatting. These updates aim to make the repository more welcoming and informative for new contributors and users.

### Key Changes

- **Expanded Introduction**: Better explains Akeru.ai's unique features and its differentiation in the AI space.
- **Detailed API Features**: Includes use cases and development status for upcoming features.
- **Clarified Bittensor Subnet Integration**: Details on how the Bittensor Subnet enhances Akeru.ai’s capabilities, including security features and decentralized benefits.
- **Preliminary Self-Hosting Info**: Provides initial guidelines on self-hosting and the requirements for validators and miners.

### Link to Issues
Expand Down
14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Akeru.ai

**Akeru.ai** is an open-source AI platform built on the cutting edge of decentralization. Leveraging the power of the Akeru AI edge network running on a Bittensor Subnet, Akeru.ai offers transparent, safe, and highly available AI capabilities.
Akeru.ai is an API platform that offers transparent, safe, and highly available AI capabilities. We strive to maintain a welcoming and inclusive community.

## What Sets Akeru.ai Apart?

Expand Down Expand Up @@ -29,17 +29,6 @@ The Akeru API, currently under development, aims for full compatibility with Ope

The Akeru API is ideal for creating AI agents and enhancing web and mobile applications with advanced AI capabilities. (Rate limits and costs are TBD).

## Bittensor Subnet Design

Akeru.ai's mission is to democratize AI technology. Running on a fleet of Bittensor validators and miners, our subnet is open to all, promoting an equitable AI future.

### Enhancements from Bittensor Subnet

While decentralization poses challenges, slowing development compared to centralized solutions, Akeru.ai embraces these challenges to ensure a decentralized and equitable AI ecosystem. Security features include:

- **Watermarking**: Verifies LLM authenticity.
- **Network Pings**: Regular checks to ensure miner availability.

### Rewards for Miners

- **Dynamic Model Popularity Rewards**: Miners offering popular models earn more.
Expand Down Expand Up @@ -68,4 +57,3 @@ We welcome contributions of all forms, from code to documentation. Here’s how
## Visuals and Diagrams

Coming soon are detailed diagrams illustrating our network architecture and API workflows, helping clarify the complexities of our systems.

9 changes: 3 additions & 6 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,14 @@ Welcome to the Akeru.ai community! We are thrilled to have you onboard. This doc

### Project Overview and Code of Conduct

[Akeru.ai](https://www.akeru.ai) leverages the power of the Akeru AI edge network running on a Bittensor Subnet to offer transparent, safe, and highly available AI capabilities. We strive to maintain a welcoming and inclusive community.
Akeru.ai is an API platform that offers transparent, safe, and highly available AI capabilities. We strive to maintain a welcoming and inclusive community.

Our [Code of Conduct](/docs/code_of_conduct.md) outlines expected behavior and practices to ensure a collaborative and respectful environment.

### Getting Started

Setting up your development environment is the first step in contributing:

- **Subnet Setup Guide**: For working with the subnet, follow the instructions [here](https://github.com/GuiBibeau/akeru/blob/main/subnet/validator/README.md).

- **Platform Setup Guide**: Additional setup instructions for the platform will be provided soon.

### Contribution Process
Expand All @@ -49,13 +47,12 @@ To contribute to [Akeru.ai](https://www.akeru.ai):

### Coding Conventions

[Akeru.ai](https://www.akeru.ai) follows Next.js linting standards in the Next app and plans to setup ESLint for the API and service mesh parts. For coding styles, we use Prettier. Our Prettier config will serve as the source of truth. View the full coding convention [here](/docs/coding_conventions.md).
[Akeru.ai](https://www.akeru.ai) follows Next.js linting standards in the Next app and plans to setup ESLint for the API and service mesh parts. For coding styles, we use Prettier. Our Prettier config will serve as the source of truth. View the full coding convention [here](/docs/coding_conventions.md).

### Building and Testing

- **Website**: Automated by Vercel.
- **API**: Currently under development for automated processes.
- **Subnet**: Managed externally; details to be provided later.

### Documentation Standards

Expand Down Expand Up @@ -90,4 +87,4 @@ Plans are in development and will be documented accordingly.

### Security Practices

Detailed security protocols, especially for the subnet, are currently under development and will be added upon completion.
Detailed security protocols will be added upon completion.
9 changes: 6 additions & 3 deletions docs/issue_and_pr_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ The README file is the first point of interaction for potential users and contri

- Expand Introduction: Clearly define what Akeru.ai does, the problems it solves, and how it's distinct from other AI platforms.
- Detail API Features: Include descriptions of current and upcoming features, expected use cases, and any associated limitations or costs.
- Clarify Bittensor Subnet Integration: Explain how the subnet supports the platform, including any security features and the advantages of decentralization.
- Update Self-Hosting and Validation Sections: Provide preliminary guidelines and expectations for users interested in self-hosting or participating as validators/miners.
- Visual Enhancements: Propose the creation of diagrams and workflows to help visually explain complex concepts.

Expand All @@ -62,6 +61,7 @@ The README file is the first point of interaction for potential users and contri
- @username2 (Technical Reviewer)

## Akeru.ai Pull Request Template

**Title**: [Descriptive title reflecting the main change]

### Description
Expand All @@ -82,28 +82,31 @@ Briefly describe the purpose of the pull request and what it aims to achieve. In
- Tag reviewers who are familiar with the impacted areas of the codebase.

### Checklist

- [ ] I have written tests.
- [ ] My code does not produce new errors.
- [ ] I gave myself a code review before asking others.

### Example

#### Title: Update README for Enhanced Project Clarity and Information

#### Description
This pull request updates the README to provide a clearer and more comprehensive understanding of Akeru.ai. The enhancements include detailed descriptions of new API features, the Bittensor Subnet integration, and improved section formatting. These updates aim to make the repository more welcoming and informative for new contributors and users.

This pull request updates the README to provide a clearer and more comprehensive understanding of Akeru.ai. The enhancements include detailed descriptions of new API features, and improved section formatting. These updates aim to make the repository more welcoming and informative for new contributors and users.

#### Key Changes

- Expanded Introduction: Better explains Akeru.ai's unique features and its differentiation in the AI space.
- Detailed API Features: Includes use cases and development status for upcoming features.
- Clarified Bittensor Subnet Integration: Details on how the Bittensor Subnet enhances Akeru.ai’s capabilities, including security features and decentralized benefits.
- Preliminary Self-Hosting Info: Provides initial guidelines on self-hosting and the requirements for validators and miners.

#### Link to Issues

- Addresses feedback from issue #[issue_number] for more detailed documentation.

#### Request for Review

- @username1
- @username2

Expand Down
2 changes: 0 additions & 2 deletions subnet/miner-cloudflare/.gitignore

This file was deleted.

21 changes: 0 additions & 21 deletions subnet/miner-cloudflare/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions subnet/miner-cloudflare/__init__.py

This file was deleted.

Empty file.
33 changes: 0 additions & 33 deletions subnet/miner-cloudflare/api/api.py

This file was deleted.

Empty file.
65 changes: 0 additions & 65 deletions subnet/miner-cloudflare/certification/certification_manager.py

This file was deleted.

14 changes: 0 additions & 14 deletions subnet/miner-cloudflare/certification/hash.py

This file was deleted.

Loading

0 comments on commit 5a9ca5b

Please sign in to comment.