Docs tidy up suggestion

elixir-nx / ortex

ONNX Runtime bindings for Elixir

MIT License

122 stars 15 forks source link

Closed josevalim closed 1 year ago

josevalim commented 1 year ago

Hi @mortont!

I took another look at the library and I am loving it. Just minor nitpicks on the docs:

I think Util and Native should be @moduledoc false
Ortex.Model and Ortex have duplicated functions. I assume we want to make the functions in Ortex.Model @doc false?
Shall we add a quick example of how to use Ortex.Serving?

josevalim commented 1 year ago

Btw, if you do those changes, you don't need a new version, you can republish the docs with mix hex.publish docs. :)

mortont commented 1 year ago

Thank you, I appreciate the feedback! I agree all of the above. I'll make those changes and republish with a simple Ortex.Serving example.

mortont commented 1 year ago

Let me know if there's anywhere else in the docs that could use some work/clarity, but for now I'll close this issue. Thanks again!