Skip to content
This repository was archived by the owner on Aug 15, 2019. It is now read-only.

Add code snippets to jsdocs. #725

Merged
merged 37 commits into from
Feb 15, 2018
Merged

Add code snippets to jsdocs. #725

merged 37 commits into from
Feb 15, 2018

Conversation

nsthorat
Copy link
Contributor

@nsthorat nsthorat commented Feb 15, 2018

  • Add lots of code snippets.
  • Remove dotProduct from docs and exports.
  • Remove vectorTimesMatrix and matrixTimesVector from docs.
  • Remove argMaxEquals from dl.* and docs. This now only lives on math for backwards compatibility.
  • Adds norm on chain API.
  • Chain API clip => clipByValue

This change is Reviewable

@nsthorat nsthorat changed the title NOT READY: Add code snippets to jsdocs. Add code snippets to jsdocs. Feb 15, 2018
@nsthorat nsthorat requested a review from dsmilkov February 15, 2018 03:08
@tafsiri
Copy link
Contributor

tafsiri commented Feb 15, 2018

Review status: 0 of 23 files reviewed at latest revision, 1 unresolved discussion, some commit checks failed.


website/scripts/api-parser.ts, line 67 at r1 (raw file):

          name: 'Classes',
          description: `<p>
          This section shows the common deeplearn.js classes and the methods

How about something like (its a small change)

"This section shows the main Tensor related classes in deeplearn.js classes and the methods we expose on them."


Comments from Reviewable

@nsthorat
Copy link
Contributor Author

Review status: 0 of 26 files reviewed at latest revision, 1 unresolved discussion, some commit checks failed.


website/scripts/api-parser.ts, line 67 at r1 (raw file):

Previously, tafsiri (Yannick Assogba) wrote…

How about something like (its a small change)

"This section shows the main Tensor related classes in deeplearn.js classes and the methods we expose on them."

Done.


Comments from Reviewable

@manrajgrover
Copy link
Contributor

@nsthorat Looks like the build process here is stuck. https://travis-ci.org/PAIR-code/deeplearnjs/builds/341998019

@nsthorat
Copy link
Contributor Author

Eek, I can't even kick it..

@manrajgrover
Copy link
Contributor

manrajgrover commented Feb 15, 2018

@nsthorat Can you try restarting/canceling the build?

@dsmilkov
Copy link
Contributor

:lgtm_strong:


Reviewed 18 of 23 files at r1, 5 of 6 files at r2, 3 of 3 files at r4, 1 of 1 files at r5.
Review status: 23 of 26 files reviewed at latest revision, 1 unresolved discussion.


Comments from Reviewable

Nikhil Thorat added 2 commits February 15, 2018 16:05
@nsthorat nsthorat merged commit bac6ce1 into master Feb 15, 2018
@nsthorat nsthorat deleted the code branch February 15, 2018 21:17
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants