tree: 40ddc54d83f050fb283af8dab7ea2bb1c8d06d31 [path history] [tgz]
  1. array_grad.cc
  2. array_grad_test.cc
  3. data_flow_grad.cc
  4. data_flow_grad_test.cc
  5. grad_testutil.cc
  6. grad_testutil.h
  7. image_grad.cc
  8. image_grad_test.cc
  9. math_grad.cc
  10. math_grad_test.cc
  11. nn_grad.cc
  12. nn_grad_test.cc
  13. README.md
tensorflow/cc/gradients/README.md

C++ gradients

Gradients are currently being ported from python to C++ (in this directory).

Contributions are welcome and much appreciated; please follow the instructions below.

  1. Create the op gradient function in foo_grad.cc corresponding to the foo_grad.py file where the op originated (i.e. array_grad.py op gradients should be written in array_grad.cc).

  2. Write the op gradient with the following naming scheme:

    Status OpNameGrad(const Scope& scope, const Operation& op,
                      const std::vector<Output>& grad_inputs,
                      std::vector<Output>* grad_outputs) {
      ...
      return scope.status();
    }
    REGISTER_GRADIENT_OP("OpName", OpNameGrad);
    
  3. Ops gradients are implemented by using the C++ API.

  4. Tests should be included in foo_grad_test.cc. Please see array_grad_test.cc for an many examples. Tests are as simple as, creating a placeholder input for the op's inputs and calling RunTest (RunTest uses a gradient checker to verify that the theoretical gradient matches the numeric gradient). For example:

    TEST_F(ArrayGradTest, IdentityGrad) {
      TensorShape shape({5, 2});
      auto x = Placeholder(scope_, DT_FLOAT, Placeholder::Shape(shape));
      auto y = Identity(scope_, x);
      RunTest(x, shape, y, shape);
    }
    

NOTE: There are some ops that require features from the C++ API that are not yet implemented.

  • Ops that require PartialTensorShape information cannot yet be implemented.

  • Ops that require SparseTensor or IndexSlices (currently only in python) cannot yet be implemented.

  • Maybe more.

For questions: Please create an issue assigned to suharshs.