Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/loss soft hkr #86

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open

Feat/loss soft hkr #86

wants to merge 11 commits into from

Conversation

franckma31
Copy link
Collaborator

Introduce the multiclass loss : MulticlassSoftHKR defined in the paper "On the explainable properties of 1-Lipschitz Neural Networks: An Optimal Transport Perspective" Serrurier et al (Neurips'23) that combine an optimal transport loss with a softmax temperature coefficient (useful when the numer of classes is high like in Imagenet dataset)

Comment on lines 416 to 421
Note that `y_true` should be one-hot encoded or pre-processed with the
`deel.lip.utils.process_labels_for_multi_gpu()` function.

Using a multi-GPU/TPU strategy requires to set `multi_gpu` to True and to
pre-process the labels `y_true` with the
`deel.lip.utils.process_labels_for_multi_gpu()` function.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If multi-GPU is not supported, we might remove/update these lines.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

comment on multi-gpu removed

deel/lip/losses.py Outdated Show resolved Hide resolved
deel/lip/losses.py Outdated Show resolved Hide resolved
(self.min_margin_v,),
dtype=tf.float32,
constraint=lambda x: tf.clip_by_value(x, 0.005, 1000),
name="moving_mean",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe change the name of this variable to avoid confusion with self.moving_mean which has the same name

deel/lip/losses.py Outdated Show resolved Hide resolved
deel/lip/losses.py Outdated Show resolved Hide resolved
Comment on lines 502 to 503
if self.one_hot_ytrue:
y_true = tf.where(y_true > 0, 1, -1) # switch to +/-1
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to use the same line as hinge_preproc? sign = tf.where(y_true > 0, 1, -1) is done whenever the y_true is 0/1 or -1/1.
If yes, it is then possible to remove self.one_hot_ytrue from the arguments of the function.

It is also possible to preprocess the y_true labels only once in hkr() function, instead of twice in preproc_kr and preproc_hinge. Like for F_soft_KR computed once at the beginning of hkr()

deel/lip/losses.py Outdated Show resolved Hide resolved
deel/lip/losses.py Outdated Show resolved Hide resolved
tests/test_losses.py Show resolved Hide resolved
Comment on lines +421 to +423
temperature (float): factor for softmax temperature
(higher value increases the weight of the highest non y_true logits)
alpha_mean (float): geometric mean factor
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docstrings of temperature and alpha_mean are not in the same order than in the __init__() signature

deel/lip/losses.py Outdated Show resolved Hide resolved
name="current_mean",
)

self.temperature = temperature * self.min_margin_v
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if it's a problem when saving with get_config() if the temperature is not the same as initialization of the loss (i.e. keeping temperature * self.min_margin_v instead of temperature alone in get_config)

Copy link
Collaborator Author

@franckma31 franckma31 Feb 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

self.temperature has to be divided by self.min_margin_v before saving. The only variable is self.current_mean but the question of serialization of the value is good

franckma31 and others added 2 commits February 15, 2024 12:01
remove useless docstring

Co-authored-by: cofri <cofri@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants