Skip to content

Commit a204538

Browse files
author
Vijay Vasudevan
committed
TensorFlow: Upstream commits to git.
Changes: - More documentation edits, fixes to anchors, fixes to mathjax, new images, etc. - Add rnn models to pip install package. Base CL: 107312343
1 parent ca4cee0 commit a204538

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+2076
-2015
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ changes to TensorFlow through
1919

2020
**We use [github issues](https://github.com/tensorflow/tensorflow/issues) for
2121
tracking requests and bugs, but please see
22-
[Community](resources/index.md#community) for general questions and
23-
discussion.**
22+
[Community](tensorflow/g3doc/resources/index.md#community) for general questions
23+
and discussion.**
2424

2525
# Download and Setup
2626

‎tensorflow/g3doc/api_docs/cc/ClassEnv.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
#Class tensorflow::Env
1+
#Class tensorflow::Env <a class="md-anchor" id="AUTOGENERATED-class-tensorflow--env"></a>
22

33
An interface used by the tensorflow implementation to access operating system functionality like the filesystem etc.
44

55
Callers may wish to provide a custom Env object to get fine grain control.
66

77
All Env implementations are safe for concurrent access from multiple threads without any external synchronization.
88

9-
##Member Summary
9+
##Member Summary <a class="md-anchor" id="AUTOGENERATED-member-summary"></a>
1010

1111
* [tensorflow::Env::Env](#tensorflow_Env_Env)
1212
* [virtual tensorflow::Env::~Env](#virtual_tensorflow_Env_Env)
@@ -39,105 +39,105 @@ All Env implementations are safe for concurrent access from multiple threads wit
3939
* [static Env* tensorflow::Env::Default](#static_Env_tensorflow_Env_Default)
4040
* Returns a default environment suitable for the current operating system.
4141

42-
##Member Details
42+
##Member Details <a class="md-anchor" id="AUTOGENERATED-member-details"></a>
4343

44-
#### tensorflow::Env::Env() {#tensorflow_Env_Env}
44+
#### tensorflow::Env::Env() <a class="md-anchor" id="tensorflow_Env_Env"></a>
4545

4646

4747

4848

4949

50-
#### virtual tensorflow::Env::~Env() {#virtual_tensorflow_Env_Env}
50+
#### virtual tensorflow::Env::~Env() <a class="md-anchor" id="virtual_tensorflow_Env_Env"></a>
5151

5252

5353

5454

5555

56-
#### virtual Status tensorflow::Env::NewRandomAccessFile(const string &amp;fname, RandomAccessFile **result)=0 {#virtual_Status_tensorflow_Env_NewRandomAccessFile}
56+
#### virtual Status tensorflow::Env::NewRandomAccessFile(const string &amp;fname, RandomAccessFile **result)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_NewRandomAccessFile"></a>
5757

5858
Creates a brand new random access read-only file with the specified name.
5959

6060
On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK. If the file does not exist, returns a non-OK status.
6161

6262
The returned file may be concurrently accessed by multiple threads.
6363

64-
#### virtual Status tensorflow::Env::NewWritableFile(const string &amp;fname, WritableFile **result)=0 {#virtual_Status_tensorflow_Env_NewWritableFile}
64+
#### virtual Status tensorflow::Env::NewWritableFile(const string &amp;fname, WritableFile **result)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_NewWritableFile"></a>
6565

6666
Creates an object that writes to a new file with the specified name.
6767

6868
Deletes any existing file with the same name and creates a new file. On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK.
6969

7070
The returned file will only be accessed by one thread at a time.
7171

72-
#### virtual Status tensorflow::Env::NewAppendableFile(const string &amp;fname, WritableFile **result)=0 {#virtual_Status_tensorflow_Env_NewAppendableFile}
72+
#### virtual Status tensorflow::Env::NewAppendableFile(const string &amp;fname, WritableFile **result)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_NewAppendableFile"></a>
7373

7474
Creates an object that either appends to an existing file, or writes to a new file (if the file does not exist to begin with).
7575

7676
On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK.
7777

7878
The returned file will only be accessed by one thread at a time.
7979

80-
#### virtual bool tensorflow::Env::FileExists(const string &amp;fname)=0 {#virtual_bool_tensorflow_Env_FileExists}
80+
#### virtual bool tensorflow::Env::FileExists(const string &amp;fname)=0 <a class="md-anchor" id="virtual_bool_tensorflow_Env_FileExists"></a>
8181

8282
Returns true iff the named file exists.
8383

8484

8585

86-
#### virtual Status tensorflow::Env::GetChildren(const string &amp;dir, std::vector&lt; string &gt; *result)=0 {#virtual_Status_tensorflow_Env_GetChildren}
86+
#### virtual Status tensorflow::Env::GetChildren(const string &amp;dir, std::vector&lt; string &gt; *result)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_GetChildren"></a>
8787

8888
Stores in *result the names of the children of the specified directory. The names are relative to &quot;dir&quot;.
8989

9090
Original contents of *results are dropped.
9191

92-
#### virtual Status tensorflow::Env::DeleteFile(const string &amp;fname)=0 {#virtual_Status_tensorflow_Env_DeleteFile}
92+
#### virtual Status tensorflow::Env::DeleteFile(const string &amp;fname)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_DeleteFile"></a>
9393

9494
Deletes the named file.
9595

9696

9797

98-
#### virtual Status tensorflow::Env::CreateDir(const string &amp;dirname)=0 {#virtual_Status_tensorflow_Env_CreateDir}
98+
#### virtual Status tensorflow::Env::CreateDir(const string &amp;dirname)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_CreateDir"></a>
9999

100100
Creates the specified directory.
101101

102102

103103

104-
#### virtual Status tensorflow::Env::DeleteDir(const string &amp;dirname)=0 {#virtual_Status_tensorflow_Env_DeleteDir}
104+
#### virtual Status tensorflow::Env::DeleteDir(const string &amp;dirname)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_DeleteDir"></a>
105105

106106
Deletes the specified directory.
107107

108108

109109

110-
#### virtual Status tensorflow::Env::GetFileSize(const string &amp;fname, uint64 *file_size)=0 {#virtual_Status_tensorflow_Env_GetFileSize}
110+
#### virtual Status tensorflow::Env::GetFileSize(const string &amp;fname, uint64 *file_size)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_GetFileSize"></a>
111111

112112
Stores the size of fname in *file_size.
113113

114114

115115

116-
#### virtual Status tensorflow::Env::RenameFile(const string &amp;src, const string &amp;target)=0 {#virtual_Status_tensorflow_Env_RenameFile}
116+
#### virtual Status tensorflow::Env::RenameFile(const string &amp;src, const string &amp;target)=0 <a class="md-anchor" id="virtual_Status_tensorflow_Env_RenameFile"></a>
117117

118118
Renames file src to target. If target already exists, it will be replaced.
119119

120120

121121

122-
#### virtual uint64 tensorflow::Env::NowMicros()=0 {#virtual_uint64_tensorflow_Env_NowMicros}
122+
#### virtual uint64 tensorflow::Env::NowMicros()=0 <a class="md-anchor" id="virtual_uint64_tensorflow_Env_NowMicros"></a>
123123

124124
Returns the number of micro-seconds since some fixed point in time. Only useful for computing deltas of time.
125125

126126

127127

128-
#### virtual void tensorflow::Env::SleepForMicroseconds(int micros)=0 {#virtual_void_tensorflow_Env_SleepForMicroseconds}
128+
#### virtual void tensorflow::Env::SleepForMicroseconds(int micros)=0 <a class="md-anchor" id="virtual_void_tensorflow_Env_SleepForMicroseconds"></a>
129129

130130
Sleeps/delays the thread for the prescribed number of micro-seconds.
131131

132132

133133

134-
#### virtual Thread* tensorflow::Env::StartThread(const ThreadOptions &amp;thread_options, const string &amp;name, std::function&lt; void()&gt; fn) TF_MUST_USE_RESULT=0 {#virtual_Thread_tensorflow_Env_StartThread}
134+
#### virtual Thread* tensorflow::Env::StartThread(const ThreadOptions &amp;thread_options, const string &amp;name, std::function&lt; void()&gt; fn) TF_MUST_USE_RESULT=0 <a class="md-anchor" id="virtual_Thread_tensorflow_Env_StartThread"></a>
135135

136136
Returns a new thread that is running fn() and is identified (for debugging/performance-analysis) by &quot;name&quot;.
137137

138138
Caller takes ownership of the result and must delete it eventually (the deletion will block until fn() stops running).
139139

140-
#### static Env* tensorflow::Env::Default() {#static_Env_tensorflow_Env_Default}
140+
#### static Env* tensorflow::Env::Default() <a class="md-anchor" id="static_Env_tensorflow_Env_Default"></a>
141141

142142
Returns a default environment suitable for the current operating system.
143143

‎tensorflow/g3doc/api_docs/cc/ClassEnvWrapper.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
#Class tensorflow::EnvWrapper
1+
#Class tensorflow::EnvWrapper <a class="md-anchor" id="AUTOGENERATED-class-tensorflow--envwrapper"></a>
22

33
An implementation of Env that forwards all calls to another Env .
44

55
May be useful to clients who wish to override just part of the functionality of another Env .
66

7-
##Member Summary
7+
##Member Summary <a class="md-anchor" id="AUTOGENERATED-member-summary"></a>
88

99
* [tensorflow::EnvWrapper::EnvWrapper](#tensorflow_EnvWrapper_EnvWrapper)
1010
* Initializes an EnvWrapper that delegates all calls to *t.
@@ -38,105 +38,105 @@ May be useful to clients who wish to override just part of the functionality of
3838
* [Thread* tensorflow::EnvWrapper::StartThread](#Thread_tensorflow_EnvWrapper_StartThread)
3939
* Returns a new thread that is running fn() and is identified (for debugging/performance-analysis) by &quot;name&quot;.
4040

41-
##Member Details
41+
##Member Details <a class="md-anchor" id="AUTOGENERATED-member-details"></a>
4242

43-
#### tensorflow::EnvWrapper::EnvWrapper(Env *t) {#tensorflow_EnvWrapper_EnvWrapper}
43+
#### tensorflow::EnvWrapper::EnvWrapper(Env *t) <a class="md-anchor" id="tensorflow_EnvWrapper_EnvWrapper"></a>
4444

4545
Initializes an EnvWrapper that delegates all calls to *t.
4646

4747

4848

49-
#### virtual tensorflow::EnvWrapper::~EnvWrapper() {#virtual_tensorflow_EnvWrapper_EnvWrapper}
49+
#### virtual tensorflow::EnvWrapper::~EnvWrapper() <a class="md-anchor" id="virtual_tensorflow_EnvWrapper_EnvWrapper"></a>
5050

5151

5252

5353

5454

55-
#### Env* tensorflow::EnvWrapper::target() const {#Env_tensorflow_EnvWrapper_target}
55+
#### Env* tensorflow::EnvWrapper::target() const <a class="md-anchor" id="Env_tensorflow_EnvWrapper_target"></a>
5656

5757
Returns the target to which this Env forwards all calls.
5858

5959

6060

61-
#### Status tensorflow::EnvWrapper::NewRandomAccessFile(const string &amp;f, RandomAccessFile **r) override {#Status_tensorflow_EnvWrapper_NewRandomAccessFile}
61+
#### Status tensorflow::EnvWrapper::NewRandomAccessFile(const string &amp;f, RandomAccessFile **r) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_NewRandomAccessFile"></a>
6262

6363
Creates a brand new random access read-only file with the specified name.
6464

6565
On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK. If the file does not exist, returns a non-OK status.
6666

6767
The returned file may be concurrently accessed by multiple threads.
6868

69-
#### Status tensorflow::EnvWrapper::NewWritableFile(const string &amp;f, WritableFile **r) override {#Status_tensorflow_EnvWrapper_NewWritableFile}
69+
#### Status tensorflow::EnvWrapper::NewWritableFile(const string &amp;f, WritableFile **r) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_NewWritableFile"></a>
7070

7171
Creates an object that writes to a new file with the specified name.
7272

7373
Deletes any existing file with the same name and creates a new file. On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK.
7474

7575
The returned file will only be accessed by one thread at a time.
7676

77-
#### Status tensorflow::EnvWrapper::NewAppendableFile(const string &amp;f, WritableFile **r) override {#Status_tensorflow_EnvWrapper_NewAppendableFile}
77+
#### Status tensorflow::EnvWrapper::NewAppendableFile(const string &amp;f, WritableFile **r) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_NewAppendableFile"></a>
7878

7979
Creates an object that either appends to an existing file, or writes to a new file (if the file does not exist to begin with).
8080

8181
On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK.
8282

8383
The returned file will only be accessed by one thread at a time.
8484

85-
#### bool tensorflow::EnvWrapper::FileExists(const string &amp;f) override {#bool_tensorflow_EnvWrapper_FileExists}
85+
#### bool tensorflow::EnvWrapper::FileExists(const string &amp;f) override <a class="md-anchor" id="bool_tensorflow_EnvWrapper_FileExists"></a>
8686

8787
Returns true iff the named file exists.
8888

8989

9090

91-
#### Status tensorflow::EnvWrapper::GetChildren(const string &amp;dir, std::vector&lt; string &gt; *r) override {#Status_tensorflow_EnvWrapper_GetChildren}
91+
#### Status tensorflow::EnvWrapper::GetChildren(const string &amp;dir, std::vector&lt; string &gt; *r) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_GetChildren"></a>
9292

9393
Stores in *result the names of the children of the specified directory. The names are relative to &quot;dir&quot;.
9494

9595
Original contents of *results are dropped.
9696

97-
#### Status tensorflow::EnvWrapper::DeleteFile(const string &amp;f) override {#Status_tensorflow_EnvWrapper_DeleteFile}
97+
#### Status tensorflow::EnvWrapper::DeleteFile(const string &amp;f) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_DeleteFile"></a>
9898

9999
Deletes the named file.
100100

101101

102102

103-
#### Status tensorflow::EnvWrapper::CreateDir(const string &amp;d) override {#Status_tensorflow_EnvWrapper_CreateDir}
103+
#### Status tensorflow::EnvWrapper::CreateDir(const string &amp;d) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_CreateDir"></a>
104104

105105
Creates the specified directory.
106106

107107

108108

109-
#### Status tensorflow::EnvWrapper::DeleteDir(const string &amp;d) override {#Status_tensorflow_EnvWrapper_DeleteDir}
109+
#### Status tensorflow::EnvWrapper::DeleteDir(const string &amp;d) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_DeleteDir"></a>
110110

111111
Deletes the specified directory.
112112

113113

114114

115-
#### Status tensorflow::EnvWrapper::GetFileSize(const string &amp;f, uint64 *s) override {#Status_tensorflow_EnvWrapper_GetFileSize}
115+
#### Status tensorflow::EnvWrapper::GetFileSize(const string &amp;f, uint64 *s) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_GetFileSize"></a>
116116

117117
Stores the size of fname in *file_size.
118118

119119

120120

121-
#### Status tensorflow::EnvWrapper::RenameFile(const string &amp;s, const string &amp;t) override {#Status_tensorflow_EnvWrapper_RenameFile}
121+
#### Status tensorflow::EnvWrapper::RenameFile(const string &amp;s, const string &amp;t) override <a class="md-anchor" id="Status_tensorflow_EnvWrapper_RenameFile"></a>
122122

123123
Renames file src to target. If target already exists, it will be replaced.
124124

125125

126126

127-
#### uint64 tensorflow::EnvWrapper::NowMicros() override {#uint64_tensorflow_EnvWrapper_NowMicros}
127+
#### uint64 tensorflow::EnvWrapper::NowMicros() override <a class="md-anchor" id="uint64_tensorflow_EnvWrapper_NowMicros"></a>
128128

129129
Returns the number of micro-seconds since some fixed point in time. Only useful for computing deltas of time.
130130

131131

132132

133-
#### void tensorflow::EnvWrapper::SleepForMicroseconds(int micros) override {#void_tensorflow_EnvWrapper_SleepForMicroseconds}
133+
#### void tensorflow::EnvWrapper::SleepForMicroseconds(int micros) override <a class="md-anchor" id="void_tensorflow_EnvWrapper_SleepForMicroseconds"></a>
134134

135135
Sleeps/delays the thread for the prescribed number of micro-seconds.
136136

137137

138138

139-
#### Thread* tensorflow::EnvWrapper::StartThread(const ThreadOptions &amp;thread_options, const string &amp;name, std::function&lt; void()&gt; fn) override {#Thread_tensorflow_EnvWrapper_StartThread}
139+
#### Thread* tensorflow::EnvWrapper::StartThread(const ThreadOptions &amp;thread_options, const string &amp;name, std::function&lt; void()&gt; fn) override <a class="md-anchor" id="Thread_tensorflow_EnvWrapper_StartThread"></a>
140140

141141
Returns a new thread that is running fn() and is identified (for debugging/performance-analysis) by &quot;name&quot;.
142142

‎tensorflow/g3doc/api_docs/cc/ClassRandomAccessFile.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,31 @@
1-
#Class tensorflow::RandomAccessFile
1+
#Class tensorflow::RandomAccessFile <a class="md-anchor" id="AUTOGENERATED-class-tensorflow--randomaccessfile"></a>
22

33
A file abstraction for randomly reading the contents of a file.
44

55

66

7-
##Member Summary
7+
##Member Summary <a class="md-anchor" id="AUTOGENERATED-member-summary"></a>
88

99
* [tensorflow::RandomAccessFile::RandomAccessFile](#tensorflow_RandomAccessFile_RandomAccessFile)
1010
* [virtual tensorflow::RandomAccessFile::~RandomAccessFile](#virtual_tensorflow_RandomAccessFile_RandomAccessFile)
1111
* [virtual Status tensorflow::RandomAccessFile::Read](#virtual_Status_tensorflow_RandomAccessFile_Read)
1212
* Reads up to &quot;n&quot; bytes from the file starting at &quot;offset&quot;.
1313

14-
##Member Details
14+
##Member Details <a class="md-anchor" id="AUTOGENERATED-member-details"></a>
1515

16-
#### tensorflow::RandomAccessFile::RandomAccessFile() {#tensorflow_RandomAccessFile_RandomAccessFile}
16+
#### tensorflow::RandomAccessFile::RandomAccessFile() <a class="md-anchor" id="tensorflow_RandomAccessFile_RandomAccessFile"></a>
1717

1818

1919

2020

2121

22-
#### virtual tensorflow::RandomAccessFile::~RandomAccessFile() {#virtual_tensorflow_RandomAccessFile_RandomAccessFile}
22+
#### virtual tensorflow::RandomAccessFile::~RandomAccessFile() <a class="md-anchor" id="virtual_tensorflow_RandomAccessFile_RandomAccessFile"></a>
2323

2424

2525

2626

2727

28-
#### virtual Status tensorflow::RandomAccessFile::Read(uint64 offset, size_t n, StringPiece *result, char *scratch) const =0 {#virtual_Status_tensorflow_RandomAccessFile_Read}
28+
#### virtual Status tensorflow::RandomAccessFile::Read(uint64 offset, size_t n, StringPiece *result, char *scratch) const =0 <a class="md-anchor" id="virtual_Status_tensorflow_RandomAccessFile_Read"></a>
2929

3030
Reads up to &quot;n&quot; bytes from the file starting at &quot;offset&quot;.
3131

0 commit comments

Comments
 (0)