tensorflow / neural-structured-learning

Training neural models with structured signals.
https://www.tensorflow.org/neural_structured_learning
Apache License 2.0
980 stars 189 forks source link

Mention the use-cases from the homepage? #99

Closed sayakpaul closed 2 years ago

sayakpaul commented 3 years ago

The official introduction page lists a couple of tutorials with NSL:

image

I think it would make sense to also mention a few community-contributed resources there. NSL already has a usage.md page. Could be reused here.

arjung commented 3 years ago

We discussed this earlier this week and our plan is to add a reference to https://github.com/tensorflow/neural-structured-learning/tree/master/neural_structured_learning/examples from that page to direct users to other examples/notebooks demonstrating NSL. I'll assign this issue to myself for getting that done.

sayakpaul commented 3 years ago

That's good. But I think that directory is incomplete as it does not mention the other works that use NSL heavily. If somehow that usage.md page could also be facilitated that would be even better.

arjung commented 3 years ago

The goal of this section is to point users to examples and notebooks to help them get started with NSL. I think the 'examples' directory should be sufficient for that in addition to the list shown above but perhaps we'll add a pointer to usage.md too -- will check with the team on that. We certainly wouldn't want to duplicate what's in usage.md on our TF webpage though.

sayakpaul commented 3 years ago

Yeah understood. Anything to enhance the visibility of the external use-cases could be accommodated. I believe you folks will definitely figure that out :)

arjung commented 2 years ago

In https://github.com/tensorflow/neural-structured-learning/commit/dd44cce3a7f386fbaf49c90c28415fa2747f820a , we added links to the examples directory from https://www.tensorflow.org/neural_structured_learning/framework as well as from our top-level README file. So, am closing this issue.