Documentation improvements #319
Merged
Conversation
This file contains hidden or 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
Codecov Report
@@ Coverage Diff @@
## master #319 +/- ##
=======================================
Coverage 72.50% 72.50%
=======================================
Files 21 21
Lines 4288 4288
=======================================
Hits 3109 3109
Misses 1179 1179 Continue to review full report at Codecov.
|
This was referenced Apr 18, 2020
|
@itamarhaber I've updated the documentation around the benchmark. what do you think? =) |
…ER_OP_PARALLELISM
hhsecond
reviewed
Apr 22, 2020
… forward on developer.md information
…files. wip on coverage fix
…a spelling on src/* and docs/*
filipecosta90
changed the title
lantiga
pushed a commit
that referenced
this pull request
May 6, 2020
Documentation improvements (#319) * WIP * WIP * WIP * WIP * Adds preview * [add] updated performance section with diagrams and some rephrasing * [add] added configuration info regarding INTRA_OP_PARALLELISM and INTER_OP_PARALLELISM * [add] added AI.DAGRUN documentation * [wip] kicked off examples page * [wip] kicked off examples page * [wip] wip on documentation * [wip] wip on documentation * [wip] chaning example image location * [wip] experimenting with image positioning on examples * [fix] correcting classified image path * [fix] fixed example image path * [fix] fixed TBD on scriptrun example * ASCII-fies diagram * ASCII-fies diagram * Dang the diagram * Diagram again * [add] kick-off the developer notes page * [wip] kick-off developer page. reference dlpack on documentation * [add] added Developer reference link * [wip] added main source files to document * [wip] improved code documentation of dag.h/c err.h/c and tensor.h/c * [wip] improved further code documentation on tensor.h * [wip] added backends.h and backends directory developer info. pushing forward on developer.md information * [add] updated model.h/c with the documentation of each method * [wip] added further documentation on the src/background_workers.h/.c files. wip on coverage fix * [wip] wip on coverage fix * [wip] added documentation to the stats.h/c and script.h/c files. Ran a spelling on src/* and docs/* * [fix] removed repeating ai.tensorget from dag's documentation * [wip] fixed formatting issues on developer.md * [fix] fixed documentation on ai.tensorget * [wip] finished code comment all methods on the major building blocks of RedisAI * Adds contrib.md * [add] documentation revision for RC - iteration 1 * [fix] updated developer notes * [fix] fixed the quickstart commands and made reference to #developer * Tweeks pt. 1 * [fix] fix performance diagram links * Tweaks pt.2 * Corrects to `MODULE LOAD` ht @DvirDukhan * Adds versioned docs and deploys docs from a GitHub Action Co-authored-by: filipecosta90 <filipecosta.90@gmail.com>
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is intended to bring the docs to level 11.
To preview locally (virtual environment highly recommended ;)):
Alternatively, this PR is CDed to: http://redisai-docs-preview.s3-website.us-east-2.amazonaws.com/
Tasks