Skip to content

Commit 7732fbf

Browse files
committed
[Docs] Udpate README.md.
Signed-off-by: Tongxuan Liu <[email protected]>
1 parent 403a53d commit 7732fbf

File tree

1 file changed

+32
-33
lines changed

1 file changed

+32
-33
lines changed

README.md

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,49 @@
1-
-----------------
2-
| **`Documentation`** |
3-
|-----------------|
4-
| [![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://www.tensorflow.org/api_docs/python/tf/estimator) |
1+
# DeepRec Estimator
52

6-
TensorFlow Estimator is a high-level TensorFlow API that greatly simplifies machine learning programming.
3+
Estimator for DeepRec is based on TensorFlow Estimator, which is high-level TensorFlow API that greatly simplifies machine learning programming.
74
Estimators encapsulate training, evaluation, prediction, and exporting for your model.
85

9-
## Getting Started
10-
11-
See our Estimator [getting started guide](https://www.tensorflow.org/guide/estimators) for an introduction to the Estimator APIs.
6+
New features in DeepRec Estimator:
7+
- Support GRPC++ for large scale distributed training in parameter server mode.
8+
- Support StarServer for large scale distributed training in parameter server mode.
129

1310
## Installation
1411

15-
`tf.estimator` is installed when you install the TensorFlow pip package. See [Installing TensorFlow](https://www.tensorflow.org/get_started/os_setup.html) for instructions.
12+
### Prepare for build
1613

17-
## Developing
14+
**CPU Dev Docker**
1815

19-
If you want to build TensorFlow Estimator locally, you will need to
20-
[install Bazel](https://docs.bazel.build/versions/master/install.html) and
21-
[install TensorFlow](https://www.tensorflow.org/install/pip).
16+
| GCC Version | Python Version | IMAGE |
17+
| ----------- | -------------- | --------------------------------------------------------- |
18+
| 9.4.0 | 3.8.10 | alideeprec/deeprec-build:deeprec-dev-cpu-py38-ubuntu20.04 |
2219

23-
```sh
24-
# To build TensorFlow Estimator whl file.
25-
bazel build //tensorflow_estimator/tools/pip_package:build_pip_package
26-
bazel-bin/tensorflow_estimator/tools/pip_package/build_pip_package /tmp/estimator_pip
20+
**GPU(cuda11.6) Dev Docker**
21+
22+
| GCC Version | Python Version | CUDA VERSION | IMAGE |
23+
| ----------- | -------------- | ------------ | --------------------------------------------------------------- |
24+
| 9.4.0 | 3.8.10 | CUDA 11.6.2 | alideeprec/deeprec-build:deeprec-dev-gpu-py38-cu116-ubuntu20.04 |
25+
26+
### Build from source
2727

28-
# To run all Estimator tests
29-
bazel test //tensorflow_estimator/...
28+
Develop Branch:master, Latest Release Branch: deeprec2302
29+
30+
**Build Package Builder**
31+
32+
```bash
33+
bazel build //tensorflow_estimator/tools/pip_package:build_pip_package
3034
```
3135

32-
## Contribution guidelines
36+
**Build Package**
3337

34-
If you want to contribute to TensorFlow Estimator, be sure to review the [contribution
35-
guidelines](CONTRIBUTING.md).
38+
```bash
39+
bazel-bin/tensorflow_estimator/tools/pip_package/build_pip_package /tmp/estimator_whl
40+
```
3641

37-
**Note that this repository is included as a component of the main TensorFlow
38-
package, and any issues encountered while using Estimators should be filed under
39-
[TensorFlow GitHub Issues](https://github.com/tensorflow/tensorflow/issues),
40-
as we do not separately track issues in this repository. You can link this
41-
repository in any issues created as necessary.**
42+
Installing DeepRec will install the native tensorflow-estimator by default, please reinstall the compiled Estimator.
4243

43-
Please see
44-
[TensorFlow Discuss](https://groups.google.com/a/tensorflow.org/forum/#!forum/discuss) for general questions
45-
and discussion and please direct specific questions to
46-
[Stack Overflow](https://stackoverflow.com/questions/tagged/tensorflow).
44+
## More details
4745

48-
## License
46+
* [GRPC++](https://github.com/DeepRec-AI/DeepRec/blob/main/docs/docs_en/GRPC%2B%2B.md)
47+
* [StarServer](https://github.com/DeepRec-AI/DeepRec/blob/main/docs/docs_en/StarServer.md)
4948

50-
[Apache License 2.0](LICENSE)
49+
See TensorFlow Estimator [getting started guide](https://www.tensorflow.org/guide/estimators) for an introduction to the Estimator APIs.

0 commit comments

Comments
 (0)