Comments (7)
The g3doc used in Tensorflow is, I believe, identical to Markdown. If you find anything that doesn't meet the markdown specification, file an issue.
from tensorflow.
I mean the comments in the C++ that are used to generate the markdown files.
Example:
https://github.com/tensorflow/tensorflow/blob/master/tensorflow/core/public/env.h#L47
/// \brief 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.
static Env* Default();
is used to generate
* [`static Env* tensorflow::Env::Default()`](#static_Env_tensorflow_Env_Default)
* Returns a default environment suitable for the current operating system.
and
#### `static Env* tensorflow::Env::Default()` {#static_Env_tensorflow_Env_Default}
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.
My point is that the docs were pre-generated. I can't find another project where Google has open sourced the g3doc utility so that others may rerun it and update the documentation.
If the answer is "the syntax is just like doxygen", then that's an acceptable answer, although it would still be nice to be given the same tool to generate the markdown.
from tensorflow.
The syntax is, in fact, doxygen: part of our docs generation pipeline calls doxygen. We are working on making more of the doc generator publicly available, but it requires a decent amount of untangling.
from tensorflow.
Is there a blog post or guide out for this yet?
from tensorflow.
Check out the documentation authoring guide: https://www.tensorflow.org/community/documentation
from tensorflow.
Is the engine now open source though? (If I didn't want to build it specifically as a part of tensorflow docs, rather use it for my own markdown rendering )?
This video (dated 2016) is really fascinating in concept. It would be great if the whole system were fully elaborated upon.
from tensorflow.
Everything from TensorFlow source code to markdown is open-source. It should be usable for other projects, although the code may have aspects specific to TensorFlow which may not trivial to extract.
TensorFlow docs are not served using g3docs. I cannot speak to the specifics of that presentation.
from tensorflow.
Related Issues (20)
- XNNPACK delegate doesn't support to broadcast last dimension for Prelu operator HOT 1
- Failing Tensorflow unit tests for BF16 hardware
- Interpreter in Swift fails with `EXC_BAD_ACCESS` at `Interpreter.copy(data, toInputAt: 0)` and `Interpreter.input(at: 0)` in some circumstances HOT 1
- Could not find any nvml.h during building from source in docker HOT 1
- Configurable attribute "deps" in @XNNPACK//:prod_microkernels doesn't match this configuration
- benchmark_model no longer cross-compiles for Android from macOS HOT 1
- Inference time using Interpreter API on Android inconsistent and 10–50 times slower than same tflite model on iOS HOT 9
- Basic regression: Predict fuel efficiency Probelm HOT 3
- [
- [Question] Is it possibile to use `jit_compile=True` (XLA) when input is a string? HOT 4
- Homepage sections displaying incorrectly on TensorFlow website HOT 2
- Wrong quantized_dimension (axis) when "per-channel" quantization
- tf.function deadlock with multiple multiprocess/threading HOT 1
- bazel rebuild the file not work HOT 1
- Denial of Service in tf.raw_ops.Unstage HOT 1
- Repository '@python' is not defined HOT 2
- Tensforflow-cpu 2.12.0 suddenly stopped working with Python 3.7-slim
- tensorflow 1.x and 2.x produce different results during inferencing based on the same parameters HOT 4
- Compile Error: Undeclared Identifier ‘tsl’ in libtensorflow
- Conda Release supporting Windows + Python 3.11
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from tensorflow.