TEP Explained

[refraction-ray]

TEP - TEP Explained

Author @refraction-ray

Status Accepted

Created 2022-06-30

Abstract

This TEP describes what TEP is and how TEP system works.

Motivation and Scope

TEP stands for TensorCircuit Enhancement Proposal. TEP is a design note for major features development in TensorCircuit. It is published as an issue and referred as the issue number, say this one is TEP #23. TEP provides information to the community (developers and users) and describes a new major feature proposal for TensorCircuit.

Each TEP must have an owner—someone who writes the TEP using the tep issue template.

For now the status of TEP is decided by @refraction-ray , we will have a committee in the future with a growing community.

Write the TEP as concise as possible, but make the proposed API and implementation design self-contained.

Usage and Impact

Mainly on developer side.

1. A better history track for feature development
2. A place to discuss whether the proposed API and implementation is ready for PR
3. A better and specific integration with tensorcircuit roadmap

Backward compatibility

No backward compatibility issue.

Related Work

Inspired from PEP and NEP.

Implementation

Using GitHub Issue system and issue templates.