Skip to content

Commit

Permalink
#79 Code Test +8
Browse files Browse the repository at this point in the history
  • Loading branch information
IvanaXu committed Nov 12, 2022
1 parent 0bdb0ee commit 2718edb
Show file tree
Hide file tree
Showing 23,665 changed files with 40,657 additions and 5,009,553 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
18 changes: 12 additions & 6 deletions pro/DeepRec/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# DeepRec Code of Conduct
# TensorFlow Code of Conduct

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.


## Our Standards
Expand All @@ -24,7 +24,7 @@ Examples of unacceptable behavior by participants include:
* Conduct which could reasonably be considered inappropriate for the forum in
which it occurs.

All DeepRec forums and spaces are meant for professional interactions, and any behavior which could reasonably be considered inappropriate in a professional setting is unacceptable.
All TensorFlow forums and spaces are meant for professional interactions, and any behavior which could reasonably be considered inappropriate in a professional setting is unacceptable.


## Our Responsibilities
Expand All @@ -36,9 +36,9 @@ Project maintainers have the right and responsibility to remove, edit, or reject

## Scope

This Code of Conduct applies to all content on DeepRec’s GitHub organization, or any other official DeepRec web presence allowing for community interactions, as well as at all official DeepRec events, whether offline or online.
This Code of Conduct applies to all content on tensorflow.org, TensorFlow’s GitHub organization, or any other official TensorFlow web presence allowing for community interactions, as well as at all official TensorFlow events, whether offline or online.

The Code of Conduct also applies within project spaces and in public spaces whenever an individual is representing DeepRec or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed or de facto representative at an online or offline event.
The Code of Conduct also applies within project spaces and in public spaces whenever an individual is representing TensorFlow or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed or de facto representative at an online or offline event.


## Conflict Resolution
Expand All @@ -60,7 +60,13 @@ If you are experiencing or witnessing conflict, we ask you to use the following

## Reporting Violations

Violations of the Code of Conduct can be reported to DeepRec’s Project Stewards, Liu Tongxuan ([email protected]). The Project Steward will determine whether the Code of Conduct was violated, and will issue an appropriate sanction, possibly including a written warning or expulsion from the project, project sponsored spaces, or project forums. We ask that you make a good-faith effort to resolve your conflict via the conflict resolution policy before submitting a report.
Violations of the Code of Conduct can be reported to TensorFlow’s Project
Stewards, Edd Wilder-James ([email protected]) and Thea Lamkin
([email protected]). The Project Steward will determine whether the Code of
Conduct was violated, and will issue an appropriate sanction, possibly including
a written warning or expulsion from the project, project sponsored spaces, or
project forums. We ask that you make a good-faith effort to resolve your
conflict via the conflict resolution policy before submitting a report.

Violations of the Code of Conduct can occur in any setting, even those unrelated to the project. We will only consider complaints about conduct that has occurred within one year of the report.

Expand Down
82 changes: 41 additions & 41 deletions pro/DeepRec/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ Before sending your pull requests, make sure you followed this list.

- Read [contributing guidelines](CONTRIBUTING.md).
- Read [Code of Conduct](CODE_OF_CONDUCT.md).
- Ensure you have signed the [Contributor License Agreement (CLA)](https://cla-assistant.io/alibaba/DeepRec).
- Check if my changes are consistent with the [guidelines](https://github.com/alibaba/DeepRec/blob/main/CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution).
- Changes are consistent with the [Coding Style](https://github.com/alibaba/DeepRec/blob/main/CONTRIBUTING.md#c-coding-style).
- Run [Unit Tests](https://github.com/alibaba/DeepRec/blob/main/CONTRIBUTING.md#running-unit-tests).
- Ensure you have signed the [Contributor License Agreement (CLA)](https://cla.developers.google.com/).
- Check if my changes are consistent with the [guidelines](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md#general-guidelines-and-philosophy-for-contribution).
- Changes are consistent with the [Coding Style](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md#c-coding-style).
- Run [Unit Tests](https://github.com/tensorflow/tensorflow/blob/master/CONTRIBUTING.md#running-unit-tests).

## How to become a contributor and submit your own code

Expand All @@ -19,34 +19,34 @@ We'd love to accept your patches! Before we can take them, we have to jump a cou

Please fill out either the individual or corporate Contributor License Agreement (CLA).

* If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](https://cla-assistant.io/alibaba/DeepRec).
* If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA](https://cla-assistant.io/alibaba/DeepRec).
* If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](https://code.google.com/legal/individual-cla-v1.0.html).
* If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA](https://code.google.com/legal/corporate-cla-v1.0.html).

Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests.

***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the main repository.

### Contributing code

If you have improvements to DeepRec, send us your pull requests! For those
If you have improvements to TensorFlow, send us your pull requests! For those
just getting started, Github has a
[how to](https://help.github.com/articles/using-pull-requests/).

DeepRec team members will be assigned to review your pull requests. Once the
pull requests are approved and pass continuous integration checks, a DeepRec
TensorFlow team members will be assigned to review your pull requests. Once the
pull requests are approved and pass continuous integration checks, a TensorFlow
team member will apply `ready to pull` label to your change. This means we are
working on getting your pull request submitted to our internal repository. After
the change has been submitted internally, your pull request will be merged
automatically on GitHub.

If you want to contribute, start working through the DeepRec codebase,
If you want to contribute, start working through the TensorFlow codebase,
navigate to the
[Github "issues" tab](https://github.com/alibaba/DeepRec/issues) and start
[Github "issues" tab](https://github.com/tensorflow/tensorflow/issues) and start
looking through interesting issues. If you are not sure of where to start, then
start by trying one of the smaller/easier issues here i.e.
[issues with the "good first issue" label](https://github.com/alibaba/DeepRec/labels/good%20first%20issue)
[issues with the "good first issue" label](https://github.com/tensorflow/tensorflow/labels/good%20first%20issue)
and then take a look at the
[issues with the "contributions welcome" label](https://github.com/alibaba/DeepRec/labels/stat%3Acontributions%20welcome).
[issues with the "contributions welcome" label](https://github.com/tensorflow/tensorflow/labels/stat%3Acontributions%20welcome).
These are issues that we believe are particularly well suited for outside
contributions, often because we probably won't get to them right now. If you
decide to start on an issue, leave a comment so that other people know that
Expand All @@ -56,9 +56,9 @@ comment thread to coordinate.
### Contribution guidelines and standards

Before sending your pull request for
[review](https://github.com/alibaba/DeepRec/pulls),
[review](https://github.com/tensorflow/tensorflow/pulls),
make sure your changes are consistent with the guidelines and follow the
DeepRec coding style.
TensorFlow coding style.

#### General guidelines and philosophy for contribution

Expand All @@ -67,16 +67,16 @@ DeepRec coding style.
changes to lower the maintenance cost.
* Bug fixes also generally require unit tests, because the presence of bugs
usually indicates insufficient test coverage.
* Keep API compatibility in mind when you change code in core DeepRec,
* Keep API compatibility in mind when you change code in core TensorFlow,
e.g., code in
[core](https://github.com/alibaba/DeepRec/tree/main/tensorflow/core)
[tensorflow/core](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/core)
and
[python](https://github.com/alibaba/DeepRec/tree/main/tensorflow/python).
DeepRec has reached version 1 and hence cannot make
[tensorflow/python](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/python).
TensorFlow has reached version 1 and hence cannot make
non-backward-compatible API changes without a major release. Reviewers of
your pull request will comment on any API compatibility issues.
* When you contribute a new feature to DeepRec, the maintenance burden is
(by default) transferred to the DeepRec team. This means that the benefit
* When you contribute a new feature to TensorFlow, the maintenance burden is
(by default) transferred to the TensorFlow team. This means that the benefit
of the contribution must be compared against the cost of maintaining the
feature.
* Full new features (e.g., a new op implementing a cutting-edge algorithm)
Expand All @@ -89,23 +89,23 @@ DeepRec coding style.

Include a license at the top of new files.

* [C/C++ license example](https://github.com/alibaba/DeepRec/blob/main/tensorflow/core/framework/op.cc#L1)
* [Python license example](https://github.com/alibaba/DeepRec/blob/main/tensorflow/python/ops/nn.py#L1)
* [Java license example](https://github.com/alibaba/DeepRec/blob/main/tensorflow/java/src/main/java/org/tensorflow/Graph.java#L1)
* [Go license example](https://github.com/alibaba/DeepRec/blob/main/tensorflow/go/operation.go#L1)
* [Bash license example](https://github.com/alibaba/DeepRec/blob/main/tensorflow/tools/ci_build/ci_sanity.sh#L2)
* [C/C++ license example](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/framework/op.cc#L1)
* [Python license example](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/python/ops/nn.py#L1)
* [Java license example](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/java/src/main/java/org/tensorflow/Graph.java#L1)
* [Go license example](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/go/operation.go#L1)
* [Bash license example](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/tools/ci_build/ci_sanity.sh#L2)
* [HTML license example](https://github.com/tensorflow/tensorboard/blob/master/tensorboard/components/tf_backend/tf-backend.html#L2)
* [JavaScript/TypeScript license example](https://github.com/tensorflow/tensorboard/blob/master/tensorboard/components/tf_backend/backend.ts#L1)

Bazel BUILD files also need to include a license section, e.g.,
[BUILD example](https://github.com/alibaba/DeepRec/blob/main/tensorflow/core/BUILD#L61).
[BUILD example](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/BUILD#L61).

#### C++ coding style

Changes to DeepRec C++ code should conform to
Changes to TensorFlow C++ code should conform to
[Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).

Use `clang-tidy` to check your C/C++ changes. To install `clang-tidy` on ubuntu:18.04, do:
Use `clang-tidy` to check your C/C++ changes. To install `clang-tidy` on ubuntu:16.04, do:

```bash
apt-get install -y clang-tidy
Expand All @@ -121,15 +121,15 @@ diff <my_cc_file> /tmp/my_cc_file.cc

#### Python coding style

Changes to DeepRec Python code should conform to
Changes to TensorFlow Python code should conform to
[Google Python Style Guide](https://github.com/google/styleguide/blob/gh-pages/pyguide.md)

Use `pylint` to check your Python changes. To install `pylint` and
retrieve DeepRec's custom style definition:
retrieve TensorFlow's custom style definition:

```bash
pip install pylint
wget -O /tmp/pylintrc https://raw.githubusercontent.com/alibaba/DeepRec/main/tensorflow/tools/ci_build/pylintrc
wget -O /tmp/pylintrc https://raw.githubusercontent.com/tensorflow/tensorflow/master/tensorflow/tools/ci_build/pylintrc
```

To check a file with `pylint`:
Expand Down Expand Up @@ -159,20 +159,20 @@ may exist in your changes.

#### Running unit tests

There are two ways to run DeepRec unit tests.
There are two ways to run TensorFlow unit tests.

1. Using tools and libraries installed directly on your system.

Refer to the
[CPU-only developer Dockerfile](https://github.com/alibaba/DeepRec/blob/main/tensorflow/tools/dockerfiles/dockerfiles/devel-cpu.Dockerfile)
[CPU-only developer Dockerfile](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/tools/dockerfiles/dockerfiles/devel-cpu.Dockerfile)
and
[GPU developer Dockerfile](https://github.com/alibaba/DeepRec/blob/main/tensorflow/tools/dockerfiles/dockerfiles/devel-gpu.Dockerfile)
[GPU developer Dockerfile](https://github.com/tensorflow/tensorflow/blob/master/tensorflow/tools/dockerfiles/dockerfiles/devel-gpu.Dockerfile)
for the required packages. Alternatively, use the said
Docker images e.g.,
[devel](registry.cn-shanghai.aliyuncs.com/pai-dlc-share/deeprec-developer:deeprec-dev-cpu-py36-ubuntu18.04) and [devel-gpu](registry.cn-shanghai.aliyuncs.com/pai-dlc-share/deeprec-developer:deeprec-dev-gpu-py36-cu110-ubuntu18.04) for
[Docker images](https://hub.docker.com/r/tensorflow/tensorflow/tags/), e.g.,
`tensorflow/tensorflow:devel` and `tensorflow/tensorflow:devel-gpu` for
development to avoid installing the packages directly on your system (in
which case remember to change directory from `/root` to `/DeepRec` once
you get into the running container so `bazel` can find the `DeepRec`
which case remember to change directory from `/root` to `/tensorflow` once
you get into the running container so `bazel` can find the `tensorflow`
workspace).

Once you have the packages installed, you can run a specific unit test in
Expand All @@ -193,13 +193,13 @@ There are two ways to run DeepRec unit tests.
bazel test ${flags} //tensorflow/python/...
```

2. Using Docker and DeepRec's CI scripts.
2. Using [Docker](https://www.docker.com) and TensorFlow's CI scripts.
```bash
# Install Docker first, then this will build and run cpu tests
tensorflow/tools/ci_build/ci_build.sh CPU bazel test //tensorflow/...
```
See
[DeepRec Builds](https://github.com/alibaba/DeepRec/tree/main/cibuild)
[TensorFlow Builds](https://github.com/tensorflow/tensorflow/tree/master/tensorflow/tools/ci_build)
for details.
20 changes: 10 additions & 10 deletions pro/DeepRec/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
Please go to Stack Overflow for help and support:

https://stackoverflow.com/questions/tagged/deeprec
https://stackoverflow.com/questions/tagged/tensorflow

If you open a GitHub issue, here is our policy:

1. It must be a bug, a feature request, or a significant problem with documentation (for small docs fixes please send a PR instead).
2. The form below must be filled out.
3. It shouldn't be a TensorBoard issue.
3. It shouldn't be a TensorBoard issue. Those go [here](https://github.com/tensorflow/tensorboard/issues).

**Here's why we have that policy**: DeepRec developers respond to issues. We want to focus on work that benefits the whole community, e.g., fixing bugs and adding features. Support only helps individuals. GitHub also notifies thousands of people when issues are filed. We want them to see you communicating an interesting problem, rather than being redirected to Stack Overflow.
**Here's why we have that policy**: TensorFlow developers respond to issues. We want to focus on work that benefits the whole community, e.g., fixing bugs and adding features. Support only helps individuals. GitHub also notifies thousands of people when issues are filed. We want them to see you communicating an interesting problem, rather than being redirected to Stack Overflow.

------------------------

### System information
- **Have I written custom code (as opposed to using a stock example script provided in DeepRec)**:
- **OS Platform and Distribution (e.g., Linux Ubuntu 18.04)**:
- **Have I written custom code (as opposed to using a stock example script provided in TensorFlow)**:
- **OS Platform and Distribution (e.g., Linux Ubuntu 16.04)**:
- **Mobile device (e.g. iPhone 8, Pixel 2, Samsung Galaxy) if the issue happens on mobile device**:
- **DeepRec installed from (source or binary)**:
- **DeepRec version (use command below)**:
- **TensorFlow installed from (source or binary)**:
- **TensorFlow version (use command below)**:
- **Python version**:
- **Bazel version (if compiling from source)**:
- **GCC/Compiler version (if compiling from source)**:
Expand All @@ -27,16 +27,16 @@ If you open a GitHub issue, here is our policy:

You can collect some of this information using our environment capture script:

https://github.com/alibaba/DeepRec/tree/main/tools/tf_env_collect.sh
https://github.com/tensorflow/tensorflow/tree/master/tools/tf_env_collect.sh

You can obtain the DeepRec version with:
You can obtain the TensorFlow version with:

```bash
python -c "import tensorflow as tf; print(tf.version.GIT_VERSION, tf.version.VERSION)"
```

### Describe the problem
Describe the problem clearly here. Be sure to convey here why it's a bug in DeepRec or a feature request.
Describe the problem clearly here. Be sure to convey here why it's a bug in TensorFlow or a feature request.

### Source code / logs
Include any logs or source code that would be helpful to diagnose the problem. If including tracebacks, please include the full traceback. Large logs and files should be attached. Try to provide a reproducible test case that is the bare minimum necessary to generate the problem.
Loading

0 comments on commit 2718edb

Please sign in to comment.