Skip to content

Commit 88e8a13

Browse files
refraction-rayrefraction-ray
committed
some open source ingredients
1 parent 144e7b4 commit 88e8a13

File tree

4 files changed

+166
-10
lines changed

4 files changed

+166
-10
lines changed

‎CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[INSERT CONTACT METHOD].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][mozilla coc].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[mozilla coc]: https://github.com/mozilla/diversity
131+
[faq]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎README.md

+27-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,31 @@
1+
English | [简体中文](README_cn.md)
2+
13
# TENSORCIRCUIT
24

5+
<p align="center">
6+
<!-- tests (GitHub actions) -->
7+
<a href="https://github.com/quclub/tensorcircuit-dev/actions/workflows/ci.yml">
8+
<img src="https://img.shields.io/github/workflow/status/quclub/tensorcircuit-dev/ci/master?logo=github&style=flat-square&logo=github" />
9+
</a>
10+
<!-- docs -->
11+
<a href="">
12+
<img src="https://img.shields.io/badge/docs-link-green.svg?style=flat-square&logo=read-the-docs"/>
13+
</a>
14+
<!-- PyPI -->
15+
<a href="https://pypi.org/project/paddle-quantum/">
16+
<img src="https://img.shields.io/pypi/v/tensorcircuit.svg?style=flat-square&logo=pypi"/>
17+
</a>
18+
<!-- License -->
19+
<a href="./LICENSE">
20+
<img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square&logo=apache"/>
21+
</a>
22+
</p>
23+
324
TensorCircuit is the next generation of quantum circuit simulator with support for automatic differentiation, just-in-time compiling, hardware acceleration, and vectorized parallelism.
425

5-
TensorCircuit is built on top of modern machine learning frameworks, and has the beautiful backend agnostic feature. It is specifically suitable for simulations of quantum-classical hybrid paradigm and variational quantum algorithms.
26+
TensorCircuit is built on top of modern machine learning frameworks, and is machine learning backend agnostic. It is specifically suitable for efficient simulations of quantum-classical hybrid paradigm and variational quantum algorithms.
627

7-
## Basic Usage
28+
## Getting Started
829

930
Please begin with [Quick Start](/docs/source/quickstart.rst) and [Jupyter Tutorials](https://github.com/quclub/tensorcircuit-tutorials/tree/master/tutorials).
1031

@@ -37,7 +58,7 @@ Automatic differentiations with jit:
3758

3859
```python
3960
def forward(theta):
40-
c = tc.Circuit(2)
61+
c = tc.Circuit(n=2)
4162
c.R(0, theta=theta, alpha=0.5, phi=0.8)
4263
return tc.backend.real(c.expectation((tc.gates.z(), [0])))
4364

@@ -55,8 +76,6 @@ For contribution guidelines and notes, see [CONTRIBUTING](/CONTRIBUTING.md).
5576

5677
Please open issues or PRs.
5778

58-
NEVER directly push to this repo!
59-
6079
Keep the codebase private!
6180

6281
### Install
@@ -85,7 +104,7 @@ black .
85104
### Linter
86105

87106
```bash
88-
pylint tensorcircuit tests
107+
pylint tensorcircuit tests examples/*.py
89108
```
90109

91110
### Type checker
@@ -96,13 +115,13 @@ mypy tensorcircuit
96115

97116
### Integrated script
98117

99-
For now, we introduce one for all checker for development:
118+
For now, we introduce one-for-all checker for development before committing:
100119

101120
```bash
102121
./check_all.sh
103122
```
104123

105-
## Research projects and application codes
124+
## Researches and applications
106125

107126
### DQAS
108127

‎README_cn.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
简体中文 | [English](README.md)
2+
3+
## TENSORCIRCUIT
4+
5+
【WIP】

‎check_all.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,5 @@ pylint tensorcircuit tests examples/*.py
99
echo "pytest check"
1010
pytest -n 4 --cov=tensorcircuit -vv -W ignore::DeprecationWarning
1111
echo "sphinx check"
12-
cd docs && sphinx-build source build/html
13-
echo "all checks passed, congratulates! 💐"
12+
cd docs && sphinx-build source build/html && sphinx-build source -D language="cn" build/html_cn
13+
echo "all checks passed, congratulation! 💐"

0 commit comments

Comments
 (0)