Skip to content

Commit

Permalink
Merge pull request #123 from jrzaurin/joss_review_tiny_changes
Browse files Browse the repository at this point in the history
Joss review tiny changes
  • Loading branch information
jrzaurin committed Jan 11, 2023
2 parents b04716b + d35bcf9 commit 6f5d20b
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.MD
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pytorch-widedeep is being developed and used by many active community members. Your help is very valuable to make it better for everyone.

- **[TBA]** Check for the [Roadmap](https://github.com/jrzaurin/pytorch-widedeep/projects/1) or [Open an issue](https://github.com/microsoft/jrzaurin/pytorch-widedeep/issues) to report problems or recommend new features and submit a draft pull requests, which will be changed to pull request after intial review
- Check for the [Roadmap](https://github.com/users/jrzaurin/projects/3) or [Open an issue](https://github.com/jrzaurin/pytorch-widedeep/issues) to report problems or recommend new features and submit a draft pull requests, which will be changed to pull request after intial review
- Contribute to the [tests](https://github.com/jrzaurin/pytorch-widedeep/tree/master/tests) to make it more reliable.
- Contribute to the [documentation](https://github.com/jrzaurin/pytorch-widedeep/tree/master/docs) to make it clearer for everyone.
- Contribute to the [examples](https://github.com/jrzaurin/pytorch-widedeep/tree/master/examples) to share your experience with other users.
Expand Down
22 changes: 14 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,15 @@ text and images using Wide and Deep models in Pytorch

The content of this document is organized as follows:

1. [introduction](#introduction)
2. [The deeptabular component](#the-deeptabular-component)
3. [installation](#installation)
4. [quick start (tl;dr)](#quick-start)
- [pytorch-widedeep](#pytorch-widedeep)
- [Introduction](#introduction)
- [The ``deeptabular`` component](#the-deeptabular-component)
- [Installation](#installation)
- [Developer Install](#developer-install)
- [Quick start](#quick-start)
- [Testing](#testing)
- [How to Contribute](#how-to-contribute)
- [Acknowledgments](#acknowledgments)

### Introduction

Expand Down Expand Up @@ -75,9 +80,10 @@ without a ``deephead`` component can be formulated as:
</p>


Where *'W'* are the weight matrices applied to the wide model and to the final
activations of the deep models, *'a'* are these final activations, and
&phi;(x) are the cross product transformations of the original features *'x'*.
Where &sigma; is the sigmoid function, *'W'* are the weight matrices applied to the wide model and to the final
activations of the deep models, *'a'* are these final activations,
&phi;(x) are the cross product transformations of the original features *'x'*, and
, and *'b'* is the bias term.
In case you are wondering what are *"cross product transformations"*, here is
a quote taken directly from the paper: *"For binary features, a cross-product
transformation (e.g., “AND(gender=female, language=en)”) is 1 if and only if
Expand Down Expand Up @@ -296,7 +302,7 @@ pytest tests

### How to Contribute

Check [CONTRIBUTING](https://github.com/jrzaurin/pytorch-widedeep/CONTRIBUTING.MD) page.
Check [CONTRIBUTING](https://github.com/jrzaurin/pytorch-widedeep/blob/master/CONTRIBUTING.MD) page.

### Acknowledgments

Expand Down
2 changes: 1 addition & 1 deletion mkdocs/sources/contributing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Pytorch-widedeep is being developed and used by many active community members. Your help is very valuable to make it better for everyone.

- **[TBA]** Check for the [Roadmap](https://github.com/jrzaurin/pytorch-widedeep/projects/1) or [Open an issue](https://github.com/microsoft/jrzaurin/pytorch-widedeep/issues) to report problems or recommend new features and submit a draft pull requests, which will be changed to pull request after intial review
- Check for the [Roadmap](https://github.com/users/jrzaurin/projects/3) or [Open an issue](https://github.com/jrzaurin/pytorch-widedeep/issues) to report problems or recommend new features and submit a draft pull requests, which will be changed to pull request after intial review
- Contribute to the [tests](https://github.com/jrzaurin/pytorch-widedeep/tree/master/tests) to make it more reliable.
- Contribute to the [documentation](https://github.com/jrzaurin/pytorch-widedeep/tree/master/docs) to make it clearer for everyone.
- Contribute to the [examples](https://github.com/jrzaurin/pytorch-widedeep/tree/master/examples) to share your experience with other users.
Expand Down
11 changes: 6 additions & 5 deletions mkdocs/sources/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ Pytorch

The content of this document is organized as follows:

- [pytorch-widedeep](#pytorch-widedeep)
- [**pytorch-widedeep**](#pytorch-widedeep)
- [Introduction](#introduction)
- [The deeptabular component](#the-deeptabular-component)
- [The ``deeptabular`` component](#the-deeptabular-component)
- [Acknowledgments](#acknowledgments)

### Introduction
Expand Down Expand Up @@ -75,9 +75,10 @@ $$



Where $W$ are the weight matrices applied to the wide model and to the final
activations of the deep models, $a$ are these final activations, and
$\phi(x)$ are the cross product transformations of the original features $x$.
Where &sigma; is the sigmoid function, *'W'* are the weight matrices applied to the wide model and to the final
activations of the deep models, *'a'* are these final activations,
&phi;(x) are the cross product transformations of the original features *'x'*, and
, and *'b'* is the bias term.
In case you are wondering what are *"cross product transformations"*, here is
a quote taken directly from the paper: *"For binary features, a cross-product
transformation (e.g., “AND(gender=female, language=en)”) is 1 if and only if
Expand Down

0 comments on commit 6f5d20b

Please sign in to comment.