forked from jikexueyuanwiki/tensorflow-zh
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5cb35a0
commit fecd208
Showing
175 changed files
with
28,732 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,146 @@ | ||
# Class `tensorflow::Env` <a class="md-anchor" id="AUTOGENERATED-class--tensorflow--env-"></a> | ||
|
||
An interface used by the tensorflow implementation to access operating system functionality like the filesystem etc. | ||
|
||
Callers may wish to provide a custom Env object to get fine grain control. | ||
|
||
All Env implementations are safe for concurrent access from multiple threads without any external synchronization. | ||
|
||
##Member Summary <a class="md-anchor" id="AUTOGENERATED-member-summary"></a> | ||
|
||
* [`tensorflow::Env::Env()`](#tensorflow_Env_Env) | ||
* [`virtual tensorflow::Env::~Env()`](#virtual_tensorflow_Env_Env) | ||
* [`virtual Status tensorflow::Env::NewRandomAccessFile(const string &fname, RandomAccessFile **result)=0`](#virtual_Status_tensorflow_Env_NewRandomAccessFile) | ||
* Creates a brand new random access read-only file with the specified name. | ||
* [`virtual Status tensorflow::Env::NewWritableFile(const string &fname, WritableFile **result)=0`](#virtual_Status_tensorflow_Env_NewWritableFile) | ||
* Creates an object that writes to a new file with the specified name. | ||
* [`virtual Status tensorflow::Env::NewAppendableFile(const string &fname, WritableFile **result)=0`](#virtual_Status_tensorflow_Env_NewAppendableFile) | ||
* 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). | ||
* [`virtual bool tensorflow::Env::FileExists(const string &fname)=0`](#virtual_bool_tensorflow_Env_FileExists) | ||
* Returns true iff the named file exists. | ||
* [`virtual Status tensorflow::Env::GetChildren(const string &dir, std::vector< string > *result)=0`](#virtual_Status_tensorflow_Env_GetChildren) | ||
* Stores in *result the names of the children of the specified directory. The names are relative to "dir". | ||
* [`virtual Status tensorflow::Env::DeleteFile(const string &fname)=0`](#virtual_Status_tensorflow_Env_DeleteFile) | ||
* Deletes the named file. | ||
* [`virtual Status tensorflow::Env::CreateDir(const string &dirname)=0`](#virtual_Status_tensorflow_Env_CreateDir) | ||
* Creates the specified directory. | ||
* [`virtual Status tensorflow::Env::DeleteDir(const string &dirname)=0`](#virtual_Status_tensorflow_Env_DeleteDir) | ||
* Deletes the specified directory. | ||
* [`virtual Status tensorflow::Env::GetFileSize(const string &fname, uint64 *file_size)=0`](#virtual_Status_tensorflow_Env_GetFileSize) | ||
* Stores the size of fname in *file_size. | ||
* [`virtual Status tensorflow::Env::RenameFile(const string &src, const string &target)=0`](#virtual_Status_tensorflow_Env_RenameFile) | ||
* Renames file src to target. If target already exists, it will be replaced. | ||
* [`virtual uint64 tensorflow::Env::NowMicros()=0`](#virtual_uint64_tensorflow_Env_NowMicros) | ||
* Returns the number of micro-seconds since some fixed point in time. Only useful for computing deltas of time. | ||
* [`virtual void tensorflow::Env::SleepForMicroseconds(int micros)=0`](#virtual_void_tensorflow_Env_SleepForMicroseconds) | ||
* Sleeps/delays the thread for the prescribed number of micro-seconds. | ||
* [`virtual Thread* tensorflow::Env::StartThread(const ThreadOptions &thread_options, const string &name, std::function< void()> fn) TF_MUST_USE_RESULT=0`](#virtual_Thread_tensorflow_Env_StartThread) | ||
* Returns a new thread that is running fn() and is identified (for debugging/performance-analysis) by "name". | ||
* [`static Env* tensorflow::Env::Default()`](#static_Env_tensorflow_Env_Default) | ||
* Returns a default environment suitable for the current operating system. | ||
|
||
##Member Details <a class="md-anchor" id="AUTOGENERATED-member-details"></a> | ||
|
||
#### `tensorflow::Env::Env()` <a class="md-anchor" id="tensorflow_Env_Env"></a> | ||
|
||
|
||
|
||
|
||
|
||
#### `virtual tensorflow::Env::~Env()` <a class="md-anchor" id="virtual_tensorflow_Env_Env"></a> | ||
|
||
|
||
|
||
|
||
|
||
#### `virtual Status tensorflow::Env::NewRandomAccessFile(const string &fname, RandomAccessFile **result)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_NewRandomAccessFile"></a> | ||
|
||
Creates a brand new random access read-only file with the specified name. | ||
|
||
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. | ||
|
||
The returned file may be concurrently accessed by multiple threads. | ||
|
||
#### `virtual Status tensorflow::Env::NewWritableFile(const string &fname, WritableFile **result)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_NewWritableFile"></a> | ||
|
||
Creates an object that writes to a new file with the specified name. | ||
|
||
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. | ||
|
||
The returned file will only be accessed by one thread at a time. | ||
|
||
#### `virtual Status tensorflow::Env::NewAppendableFile(const string &fname, WritableFile **result)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_NewAppendableFile"></a> | ||
|
||
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). | ||
|
||
On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK. | ||
|
||
The returned file will only be accessed by one thread at a time. | ||
|
||
#### `virtual bool tensorflow::Env::FileExists(const string &fname)=0` <a class="md-anchor" id="virtual_bool_tensorflow_Env_FileExists"></a> | ||
|
||
Returns true iff the named file exists. | ||
|
||
|
||
|
||
#### `virtual Status tensorflow::Env::GetChildren(const string &dir, std::vector< string > *result)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_GetChildren"></a> | ||
|
||
Stores in *result the names of the children of the specified directory. The names are relative to "dir". | ||
|
||
Original contents of *results are dropped. | ||
|
||
#### `virtual Status tensorflow::Env::DeleteFile(const string &fname)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_DeleteFile"></a> | ||
|
||
Deletes the named file. | ||
|
||
|
||
|
||
#### `virtual Status tensorflow::Env::CreateDir(const string &dirname)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_CreateDir"></a> | ||
|
||
Creates the specified directory. | ||
|
||
|
||
|
||
#### `virtual Status tensorflow::Env::DeleteDir(const string &dirname)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_DeleteDir"></a> | ||
|
||
Deletes the specified directory. | ||
|
||
|
||
|
||
#### `virtual Status tensorflow::Env::GetFileSize(const string &fname, uint64 *file_size)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_GetFileSize"></a> | ||
|
||
Stores the size of fname in *file_size. | ||
|
||
|
||
|
||
#### `virtual Status tensorflow::Env::RenameFile(const string &src, const string &target)=0` <a class="md-anchor" id="virtual_Status_tensorflow_Env_RenameFile"></a> | ||
|
||
Renames file src to target. If target already exists, it will be replaced. | ||
|
||
|
||
|
||
#### `virtual uint64 tensorflow::Env::NowMicros()=0` <a class="md-anchor" id="virtual_uint64_tensorflow_Env_NowMicros"></a> | ||
|
||
Returns the number of micro-seconds since some fixed point in time. Only useful for computing deltas of time. | ||
|
||
|
||
|
||
#### `virtual void tensorflow::Env::SleepForMicroseconds(int micros)=0` <a class="md-anchor" id="virtual_void_tensorflow_Env_SleepForMicroseconds"></a> | ||
|
||
Sleeps/delays the thread for the prescribed number of micro-seconds. | ||
|
||
|
||
|
||
#### `virtual Thread* tensorflow::Env::StartThread(const ThreadOptions &thread_options, const string &name, std::function< void()> fn) TF_MUST_USE_RESULT=0` <a class="md-anchor" id="virtual_Thread_tensorflow_Env_StartThread"></a> | ||
|
||
Returns a new thread that is running fn() and is identified (for debugging/performance-analysis) by "name". | ||
|
||
Caller takes ownership of the result and must delete it eventually (the deletion will block until fn() stops running). | ||
|
||
#### `static Env* tensorflow::Env::Default()` <a class="md-anchor" id="static_Env_tensorflow_Env_Default"></a> | ||
|
||
Returns a default environment suitable for the current operating system. | ||
|
||
Sophisticated users may wish to provide their own Env implementation instead of relying on this default environment. | ||
|
||
The result of Default() belongs to this library and must never be deleted. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,143 @@ | ||
# Class `tensorflow::EnvWrapper` <a class="md-anchor" id="AUTOGENERATED-class--tensorflow--envwrapper-"></a> | ||
|
||
An implementation of Env that forwards all calls to another Env . | ||
|
||
May be useful to clients who wish to override just part of the functionality of another Env . | ||
|
||
##Member Summary <a class="md-anchor" id="AUTOGENERATED-member-summary"></a> | ||
|
||
* [`tensorflow::EnvWrapper::EnvWrapper(Env *t)`](#tensorflow_EnvWrapper_EnvWrapper) | ||
* Initializes an EnvWrapper that delegates all calls to *t. | ||
* [`virtual tensorflow::EnvWrapper::~EnvWrapper()`](#virtual_tensorflow_EnvWrapper_EnvWrapper) | ||
* [`Env* tensorflow::EnvWrapper::target() const`](#Env_tensorflow_EnvWrapper_target) | ||
* Returns the target to which this Env forwards all calls. | ||
* [`Status tensorflow::EnvWrapper::NewRandomAccessFile(const string &f, RandomAccessFile **r) override`](#Status_tensorflow_EnvWrapper_NewRandomAccessFile) | ||
* Creates a brand new random access read-only file with the specified name. | ||
* [`Status tensorflow::EnvWrapper::NewWritableFile(const string &f, WritableFile **r) override`](#Status_tensorflow_EnvWrapper_NewWritableFile) | ||
* Creates an object that writes to a new file with the specified name. | ||
* [`Status tensorflow::EnvWrapper::NewAppendableFile(const string &f, WritableFile **r) override`](#Status_tensorflow_EnvWrapper_NewAppendableFile) | ||
* 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). | ||
* [`bool tensorflow::EnvWrapper::FileExists(const string &f) override`](#bool_tensorflow_EnvWrapper_FileExists) | ||
* Returns true iff the named file exists. | ||
* [`Status tensorflow::EnvWrapper::GetChildren(const string &dir, std::vector< string > *r) override`](#Status_tensorflow_EnvWrapper_GetChildren) | ||
* Stores in *result the names of the children of the specified directory. The names are relative to "dir". | ||
* [`Status tensorflow::EnvWrapper::DeleteFile(const string &f) override`](#Status_tensorflow_EnvWrapper_DeleteFile) | ||
* Deletes the named file. | ||
* [`Status tensorflow::EnvWrapper::CreateDir(const string &d) override`](#Status_tensorflow_EnvWrapper_CreateDir) | ||
* Creates the specified directory. | ||
* [`Status tensorflow::EnvWrapper::DeleteDir(const string &d) override`](#Status_tensorflow_EnvWrapper_DeleteDir) | ||
* Deletes the specified directory. | ||
* [`Status tensorflow::EnvWrapper::GetFileSize(const string &f, uint64 *s) override`](#Status_tensorflow_EnvWrapper_GetFileSize) | ||
* Stores the size of fname in *file_size. | ||
* [`Status tensorflow::EnvWrapper::RenameFile(const string &s, const string &t) override`](#Status_tensorflow_EnvWrapper_RenameFile) | ||
* Renames file src to target. If target already exists, it will be replaced. | ||
* [`uint64 tensorflow::EnvWrapper::NowMicros() override`](#uint64_tensorflow_EnvWrapper_NowMicros) | ||
* Returns the number of micro-seconds since some fixed point in time. Only useful for computing deltas of time. | ||
* [`void tensorflow::EnvWrapper::SleepForMicroseconds(int micros) override`](#void_tensorflow_EnvWrapper_SleepForMicroseconds) | ||
* Sleeps/delays the thread for the prescribed number of micro-seconds. | ||
* [`Thread* tensorflow::EnvWrapper::StartThread(const ThreadOptions &thread_options, const string &name, std::function< void()> fn) override`](#Thread_tensorflow_EnvWrapper_StartThread) | ||
* Returns a new thread that is running fn() and is identified (for debugging/performance-analysis) by "name". | ||
|
||
##Member Details <a class="md-anchor" id="AUTOGENERATED-member-details"></a> | ||
|
||
#### `tensorflow::EnvWrapper::EnvWrapper(Env *t)` <a class="md-anchor" id="tensorflow_EnvWrapper_EnvWrapper"></a> | ||
|
||
Initializes an EnvWrapper that delegates all calls to *t. | ||
|
||
|
||
|
||
#### `virtual tensorflow::EnvWrapper::~EnvWrapper()` <a class="md-anchor" id="virtual_tensorflow_EnvWrapper_EnvWrapper"></a> | ||
|
||
|
||
|
||
|
||
|
||
#### `Env* tensorflow::EnvWrapper::target() const` <a class="md-anchor" id="Env_tensorflow_EnvWrapper_target"></a> | ||
|
||
Returns the target to which this Env forwards all calls. | ||
|
||
|
||
|
||
#### `Status tensorflow::EnvWrapper::NewRandomAccessFile(const string &f, RandomAccessFile **r) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_NewRandomAccessFile"></a> | ||
|
||
Creates a brand new random access read-only file with the specified name. | ||
|
||
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. | ||
|
||
The returned file may be concurrently accessed by multiple threads. | ||
|
||
#### `Status tensorflow::EnvWrapper::NewWritableFile(const string &f, WritableFile **r) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_NewWritableFile"></a> | ||
|
||
Creates an object that writes to a new file with the specified name. | ||
|
||
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. | ||
|
||
The returned file will only be accessed by one thread at a time. | ||
|
||
#### `Status tensorflow::EnvWrapper::NewAppendableFile(const string &f, WritableFile **r) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_NewAppendableFile"></a> | ||
|
||
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). | ||
|
||
On success, stores a pointer to the new file in *result and returns OK. On failure stores NULL in *result and returns non-OK. | ||
|
||
The returned file will only be accessed by one thread at a time. | ||
|
||
#### `bool tensorflow::EnvWrapper::FileExists(const string &f) override` <a class="md-anchor" id="bool_tensorflow_EnvWrapper_FileExists"></a> | ||
|
||
Returns true iff the named file exists. | ||
|
||
|
||
|
||
#### `Status tensorflow::EnvWrapper::GetChildren(const string &dir, std::vector< string > *r) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_GetChildren"></a> | ||
|
||
Stores in *result the names of the children of the specified directory. The names are relative to "dir". | ||
|
||
Original contents of *results are dropped. | ||
|
||
#### `Status tensorflow::EnvWrapper::DeleteFile(const string &f) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_DeleteFile"></a> | ||
|
||
Deletes the named file. | ||
|
||
|
||
|
||
#### `Status tensorflow::EnvWrapper::CreateDir(const string &d) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_CreateDir"></a> | ||
|
||
Creates the specified directory. | ||
|
||
|
||
|
||
#### `Status tensorflow::EnvWrapper::DeleteDir(const string &d) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_DeleteDir"></a> | ||
|
||
Deletes the specified directory. | ||
|
||
|
||
|
||
#### `Status tensorflow::EnvWrapper::GetFileSize(const string &f, uint64 *s) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_GetFileSize"></a> | ||
|
||
Stores the size of fname in *file_size. | ||
|
||
|
||
|
||
#### `Status tensorflow::EnvWrapper::RenameFile(const string &s, const string &t) override` <a class="md-anchor" id="Status_tensorflow_EnvWrapper_RenameFile"></a> | ||
|
||
Renames file src to target. If target already exists, it will be replaced. | ||
|
||
|
||
|
||
#### `uint64 tensorflow::EnvWrapper::NowMicros() override` <a class="md-anchor" id="uint64_tensorflow_EnvWrapper_NowMicros"></a> | ||
|
||
Returns the number of micro-seconds since some fixed point in time. Only useful for computing deltas of time. | ||
|
||
|
||
|
||
#### `void tensorflow::EnvWrapper::SleepForMicroseconds(int micros) override` <a class="md-anchor" id="void_tensorflow_EnvWrapper_SleepForMicroseconds"></a> | ||
|
||
Sleeps/delays the thread for the prescribed number of micro-seconds. | ||
|
||
|
||
|
||
#### `Thread* tensorflow::EnvWrapper::StartThread(const ThreadOptions &thread_options, const string &name, std::function< void()> fn) override` <a class="md-anchor" id="Thread_tensorflow_EnvWrapper_StartThread"></a> | ||
|
||
Returns a new thread that is running fn() and is identified (for debugging/performance-analysis) by "name". | ||
|
||
Caller takes ownership of the result and must delete it eventually (the deletion will block until fn() stops running). |
Oops, something went wrong.