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)
- Infinity loop when try to save model with input_signatures on funtion decorator
- Tensorflow does not recognice GPU no matter what HOT 2
- __dict__ error when saving a model using tf.saved_model.save(model, modelSavedPath)
- softplus on zero values is incorrect HOT 3
- We integrate tensorflow movenet with our webapp, and it stopped working (it worked two weeks ago) with the following error message, what can be the possible reasons and how to fix it? HOT 2
- Tensorflow TF ops - CPU Factory not registered HOT 8
- Complex dtype input for keras layer in tf2.16+
- [Android x86_64] [TFLite] `Fatal signal 11 (SIGSEGV), code 128 (SI_KERNEL), fault addr 0x0` crash from `libtensorflowlite.so` HOT 1
- [DOCS] Missing complex input for Round op HOT 1
- Ensemble provides either correct or (the same) incorrect inference results HOT 1
- tf.keras.utils.plot_model doesn't work
- tf.raw_ops.Unbatch aborts with "Check failed: d < dims()" HOT 3
- Incorrect documentation of the hard_sigmoid activation function (TensorFlow 2.16.1) HOT 4
- CategoryEncoding layer with output_mode count as part of a model no longer working in TensorFlow 2.16.1 HOT 1
- TimeDistributed layer with nested model no longer working in TensorFlow 2.16.1
- Loading of a model with a Bidirectional LSTM layer no longer working in TensorFlow 2.16.1
- Documentation for RaggedTensors does not match Input layer documentation HOT 2
- Tensorflow doesn't work on my data HOT 2
- Segmentation fault when using tflite_model_maker searcher.TextDataLoader.create(EmbeddingModel, l2_normalize=True)
- ValueError: Only instances of `keras.Layer` can be added to a Sequential model. " Keras version - 3.5.0" HOT 2
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.