tensorflow / swift

Swift for TensorFlow
https://tensorflow.org/swift
Apache License 2.0
6.13k stars 606 forks source link

check swift api colab links #579

Closed brettkoonce closed 3 years ago

brettkoonce commented 3 years ago
 https://www.tensorflow.org/swift/tutorials/using_raw_tensorflow_operators

click run in google colab -->

https://colab.research.google.com/github/tensorflow/swift/blob/master/docs/site/tutorials/using_raw_tensorflow_operators.ipynb

-->

Notebook not found
There was an error loading this notebook. Ensure that the file is accessible and try again.
https://github.com/tensorflow/swift/blob/master/docs/site/tutorials/using_raw_tensorflow_operators.ipynb

-->

Could not find using_raw_tensorflow_operators.ipynb in https://api.github.com/repos/tensorflow/swift/contents/docs/site/tutorials?per_page=100&ref=master
CustomError: Could not find using_raw_tensorflow_operators.ipynb in https://api.github.com/repos/tensorflow/swift/contents/docs/site/tutorials?per_page=100&ref=master
    at new oB (https://colab.research.google.com/v2/external/external_polymer_binary.js?vrz=colab-20201203-085602-RC00_345431730:1326:22)
    at Ca.program_ (https://colab.research.google.com/v2/external/external_polymer_binary.js?vrz=colab-20201203-085602-RC00_345431730:1312:440)
    at Ea (https://colab.research.google.com/v2/external/external_polymer_binary.js?vrz=colab-20201203-085602-RC00_345431730:19:336)
    at Ca.next_ (https://colab.research.google.com/v2/external/external_polymer_binary.js?vrz=colab-20201203-085602-RC00_345431730:17:503)
    at Ga.next (https://colab.research.google.com/v2/external/external_polymer_binary.js?vrz=colab-20201203-085602-RC00_345431730:20:206)
    at b (https://colab.research.google.com/v2/external/external_polymer_binary.js?vrz=colab-20201203-085602-RC00_345431730:20:465)
brettkoonce commented 3 years ago

looks like is using master branch, ping @texasmichelle

brettkoonce commented 3 years ago

github links are 404 as well

brettkoonce commented 3 years ago

see also

https://www.tensorflow.org/s/results?hl=CA&q=TensorElementLiteral

-->

https://www.tensorflow.org/swift/api_docs/Structs/TensorElementLiteral?hl=CA

texasmichelle commented 3 years ago

Hi Brett, thanks for reporting these broken links! It looks like the first one is a deletion artifact that was mistakenly left around. The link from the main site points to https://www.tensorflow.org/swift/tutorials/raw_tensorflow_operators instead. The old link with broken references to Colab & GitHub has been removed.

texasmichelle commented 3 years ago

As for the second link, I'm not sure why TensorElementLiteral shows up in search results. I don't believe we generate API docs for structs prepended with _. That struct in particular should never be used directly.

I'll follow up with the docs team to see if we can clean up search results.

brettkoonce commented 3 years ago

@texasmichelle thanks for checking things out!