Commit b0fd261b authored by L.S. Cook's avatar L.S. Cook Committed by Scott Cyphers

Cleanup grammar on documentation for tensor and backend (#1825)

parent e9fc89ae
.. ops/index.rst
Core Ops
========
About Core Ops
==============
An ``Op``'s primary role is to function as a node in a directed acyclic graph
dependency computation graph.
......@@ -40,7 +40,7 @@ that must be performed are:
Alphabetical list of Core ``ops``
----------------------------------
=================================
Not currently a comprehensive list.
......@@ -163,5 +163,3 @@ Not currently a comprehensive list.
sqrt.rst
tan.rst
tanh.rst
......@@ -54,7 +54,7 @@ public:
/// \brief Create a tensor specific to this backend
/// \param element_type The type of the tensor element
/// \param shape The shape of the tensor
/// \returns shared_ptr to a new backend specific tensor
/// \returns shared_ptr to a new backend-specific tensor
virtual std::shared_ptr<ngraph::runtime::Tensor>
create_tensor(const ngraph::element::Type& element_type, const Shape& shape) = 0;
......@@ -64,7 +64,7 @@ public:
/// \param memory_pointer A pointer to a buffer used for this tensor. The size of the buffer
/// must be sufficient to contain the tensor. The lifetime of the buffer is the
/// responsibility of the caller.
/// \returns shared_ptr to a new backend specific tensor
/// \returns shared_ptr to a new backend-specific tensor
virtual std::shared_ptr<ngraph::runtime::Tensor> create_tensor(
const ngraph::element::Type& element_type, const Shape& shape, void* memory_pointer) = 0;
......@@ -107,8 +107,8 @@ public:
/// \param func The function to execute
virtual void remove_compiled_function(std::shared_ptr<Function> func);
/// \brief Enable the collection of per op performance information on a specified Function.
/// Data is collection via the `get_performance_data` method.
/// \brief Enable the collection of per-op performance information on a specified Function.
/// Data collection is via the `get_performance_data` method.
/// \param func The function to collect perfomance data on.
/// \param enable Set to true to enable or false to disable data collection
virtual void enable_performance_data(std::shared_ptr<Function> func, bool enable) {}
......
......@@ -78,12 +78,12 @@ namespace ngraph
/// \param layout Layout to set
void set_tensor_layout(const std::shared_ptr<descriptor::layout::TensorLayout>& layout);
/// \brief Get the stale value of the tensor. A tensor is stale if it's data is
/// \brief Get the stale value of the tensor. A tensor is stale if its data is
/// changed.
/// \return true if there is new data in this tensor
bool get_stale() const;
/// \brief Set the stale value of the tensor. A tensor is stale if it's data is
/// \brief Set the stale value of the tensor. A tensor is stale if its data is
/// changed.
void set_stale(bool val);
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment