Documentation Contrib?

131 views
Skip to first unread message

Doug Friedman

unread,
Mar 26, 2019, 11:36:05 AM3/26/19
to Swift for TensorFlow
Is there a list anywhere of documentation needs for Swift for Tensorflow?  I'm interested in contributing to the docs because in my experience it is a very good way to start to get familiar with the project. 

I know its harder to create a "ticket" or spec for docs but if there are any docs that need to be written from scratch or just cleaned up/improved I'd be willing to take a look.

Thanks!

Dan Zheng

unread,
Mar 26, 2019, 8:22:27 PM3/26/19
to Doug Friedman, Swift for TensorFlow
Hi Doug,

Thank you for your interest in helping with documentation!

One area that needs documentation is Python library usage, specifically "how to set the Python library version".
The `PythonLibrary.useVersion` function and related environment variables are only documented informally in a Gist.
It would be nice to document these formally in the Python interoperability Colab, in a text section near the top.

I filed a bug with more details, please take a look. Would you be interested in helping with this?

Thanks,
Dan


--
You received this message because you are subscribed to the Google Groups "Swift for TensorFlow" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swift+un...@tensorflow.org.

Doug Friedman

unread,
Mar 26, 2019, 9:20:14 PM3/26/19
to Dan Zheng, Swift for TensorFlow
Yep 👍 sounds good.

Dan Zheng

unread,
Mar 26, 2019, 9:22:29 PM3/26/19
to Doug Friedman, Swift for TensorFlow
Great! (Please self-assign the bug if you start working on it.)

Dan

Chris Lattner

unread,
Mar 26, 2019, 11:31:05 PM3/26/19
to Doug Friedman, Swift for TensorFlow


> On Mar 26, 2019, at 8:36 AM, Doug Friedman <dfri...@gmail.com> wrote:
>
> Is there a list anywhere of documentation needs for Swift for Tensorflow? I'm interested in contributing to the docs because in my experience it is a very good way to start to get familiar with the project.
>
> I know its harder to create a "ticket" or spec for docs but if there are any docs that need to be written from scratch or just cleaned up/improved I'd be willing to take a look.

Awesome, welcome to the project Doug!

-Chris

build.deb...@gmail.com

unread,
Mar 27, 2019, 6:38:35 PM3/27/19
to Swift for TensorFlow, dfri...@gmail.com
I'm also very much interested in helping out on documentation or perhaps adding new models to https://github.com/tensorflow/swift-models. Is there anything besides `PythonLibrary.useVersion` that would be useful to document? I've noticed there isn't a tutorial on transfer learning--I'd be more than happy to create one in the same vein as the existing tutorials. An example that loads weights from a pretrained model may serve as useful. I'd be glad to help in any way I can. 

-James

To unsubscribe from this group and stop receiving emails from it, send an email to sw...@tensorflow.org.

Richard Wei

unread,
Mar 27, 2019, 6:58:23 PM3/27/19
to build.deb...@gmail.com, Swift for TensorFlow, dfri...@gmail.com
Hi James,

As for transfer learning, the infrastructure support for model saving/loading has not been developed yet, and we are actively working on it. At this point, it is not super straightforward (like just conforming to Codable) and may require language/stdlib changes. We’ll share examples when we have saving/loading APIs.

-Richard

To unsubscribe from this group and stop receiving emails from it, send an email to swift+un...@tensorflow.org.

Richard Wei

unread,
Mar 28, 2019, 7:08:43 PM3/28/19
to build.deb...@gmail.com, Swift for TensorFlow, Doug Friedman
Hi all, 

Just thinking about documentation, we are currently lacking a tutorial that describes how to use device placement APIs, namely withDevice(_:_:perform:), withDefaultDevice(perform:)enableGPU(), and enableCPU(). It'd be awesome if someone can write a Colab tutorial for these APIs!

-Richard

James Thompson

unread,
Mar 28, 2019, 7:16:55 PM3/28/19
to Swift for TensorFlow, build.deb...@gmail.com, dfri...@gmail.com
Hey Richard,

I'd be more than happy to help in any way I can. Should I just file a bug or task on the S4TF JIRA?

-James

On Thursday, March 28, 2019 at 4:08:43 PM UTC-7, Richard Wei wrote:
Hi all, 

Just thinking about documentation, we are currently lacking a tutorial that describes how to use device placement APIs, namely withDevice(_:_:perform:), withDefaultDevice(perform:)enableGPU(), and enableCPU(). It'd be awesome if someone can write a Colab tutorial for these APIs!

-Richard

On Wed, Mar 27, 2019 at 3:58 PM Richard Wei <rx...@google.com> wrote:
Hi James,

As for transfer learning, the infrastructure support for model saving/loading has not been developed yet, and we are actively working on it. At this point, it is not super straightforward (like just conforming to Codable) and may require language/stdlib changes. We’ll share examples when we have saving/loading APIs.

-Richard

On Mar 27, 2019, at 3:38 PM, build.de...@gmail.com wrote:

I'm also very much interested in helping out on documentation or perhaps adding new models to https://github.com/tensorflow/swift-models. Is there anything besides `PythonLibrary.useVersion` that would be useful to document? I've noticed there isn't a tutorial on transfer learning--I'd be more than happy to create one in the same vein as the existing tutorials. An example that loads weights from a pretrained model may serve as useful. I'd be glad to help in any way I can. 

-James

On Tuesday, March 26, 2019 at 5:22:27 PM UTC-7, Dan Zheng wrote:
Hi Doug,

Thank you for your interest in helping with documentation!

One area that needs documentation is Python library usage, specifically "how to set the Python library version".
The `PythonLibrary.useVersion` function and related environment variables are only documented informally in a Gist.
It would be nice to document these formally in the Python interoperability Colab, in a text section near the top.

I filed a bug with more details, please take a look. Would you be interested in helping with this?

Thanks,
Dan


On Tue, Mar 26, 2019 at 8:36 AM Doug Friedman <dfri...@gmail.com> wrote:
Is there a list anywhere of documentation needs for Swift for Tensorflow?  I'm interested in contributing to the docs because in my experience it is a very good way to start to get familiar with the project.  

I know its harder to create a "ticket" or spec for docs but if there are any docs that need to be written from scratch or just cleaned up/improved I'd be willing to take a look.

Thanks!


-- 
You received this message because you are subscribed to the Google Groups "Swift for TensorFlow" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sw...@tensorflow.org.

-- 
You received this message because you are subscribed to the Google Groups "Swift for TensorFlow" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sw...@tensorflow.org.

Richard Wei

unread,
Mar 28, 2019, 7:19:39 PM3/28/19
to James Thompson, Swift for TensorFlow, build.deb...@gmail.com, Doug Friedman
Sounds great! For tutorials contributions, a GitHub issue is okay and easier to close when you have a PR ready.

-Richard

To unsubscribe from this group and stop receiving emails from it, send an email to swift+un...@tensorflow.org.

James Thompson

unread,
Mar 28, 2019, 7:32:26 PM3/28/19
to Swift for TensorFlow, jimmy...@gmail.com, build.deb...@gmail.com, dfri...@gmail.com
Sounds good. Here's the issue: https://github.com/tensorflow/swift/issues/167 I'll get started on it soon!

-James
To unsubscribe from this group and stop receiving emails from it, send an email to sw...@tensorflow.org.

Walter Wiggins

unread,
Mar 28, 2019, 8:24:00 PM3/28/19
to Swift for TensorFlow
I’m also following this thread and happy to help if you think of any other documentation needs
Reply all
Reply to author
Forward
0 new messages