Skip to content

Tuto for windows users - #688

Merged
jrapin merged 45 commits into
facebookresearch:masterfrom
fteytaud:windowsDoc
May 20, 2020
Merged

Tuto for windows users#688
jrapin merged 45 commits into
facebookresearch:masterfrom
fteytaud:windowsDoc

Conversation

@fteytaud

Copy link
Copy Markdown

Types of changes

  • Docs change / refactoring / dependency upgrade
  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Motivation and Context / Related issue

Solving issue #592.
I am not at all a windows expert, but I try to do something as simple as possible.

How Has This Been Tested (if it applies)

Checklist

  • The documentation is up-to-date with the changes I made.
  • I have read the CONTRIBUTING document and completed the CLA (see CLA).
  • All tests passed, and additional code has been covered with new tests.

@facebook-github-bot facebook-github-bot added the CLA Signed Do not delete this pull request or issue due to inactivity. label May 19, 2020

@jrapin jrapin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Didnt have time to check in details but I trust this should be nice ;) I'll try to build the documentation on my side too
I would just update the links to the documentation, and can "CtrlWindowsAlt.jpg " be reduced? It's 10x bigger than the other ones

Comment thread README.md Outdated
Comment on lines +72 to +74
## Windows installation

For windows installation, please refer to [the windows documention](docs/windows.md)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Most of the install intructions are in getting started, you should at least add a link there as well.
I would tend to remove the lines here and update line 14 to state that Windows install can be found there

@fteytaud fteytaud May 19, 2020

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I forgot : Thx for your answer :)

I have reduced all images, it was quite ugly (not sure this is beautiful now, I think I am not good at this :) ).
I have corrected the links, as you suggested. I am not familiar to rst, so I just add a

Installing on Windows
----------

For windows installation, please refer to `the windows documention <https://github.com/facebookresearch/nevergrad/blob/master/docs/windows.md>`

in the getting_started.rst file. Not sure if this is a good way to do it :)
(and I can't check the link)

@jrapin

jrapin commented May 20, 2020

Copy link
Copy Markdown
Contributor

I've made a PR on your PR to update the links: fteytaud#1
After that it should be ok ;) Thanks!
I'll probably update the document eventually though, to use rst, and maybe move the PR part to the contributing section. But that will wait for now ;)

@fteytaud

Copy link
Copy Markdown
Author

Ok thx. Let me know if you need something.

@jrapin

jrapin commented May 20, 2020

Copy link
Copy Markdown
Contributor

Ok thx. Let me know if you need something.

Just merge my PR into yours (should work by just clicking "merge" in fteytaud#1)

Link to the windows documentation
@jrapin
jrapin merged commit aace8d9 into facebookresearch:master May 20, 2020
teytaud pushed a commit that referenced this pull request May 25, 2020
teytaud added a commit that referenced this pull request May 25, 2020
* firstMetaModel

* meta_model_for_shiva

* fix

* Type_fix:_.value_was_missing. Also better handling of exceptions.

* Tell not asked: I'm lost.

* Add recommendation.

* Add recommendation.

* Let us catch bad big values in metamodels.

* Deactivate BO test for windows

* Add metamodel in illcond tests.

* fixstaticanalysis

* Update optimizerlib.py

* updateMetaModel (#692)

* updateMetaModel

* Update optimizerlib.py

* Check suggest recommendation (#635)

* Add basic Pylint tests (#669)

* Allow repetitions for Choice parameters (#670)

* firstMetaModel

* meta_model_for_shiva

* Update post version number

* Fix repeated Choice hash (#676)

* fix

* Type_fix:_.value_was_missing. Also better handling of exceptions.

* Tell not asked: I'm lost.

* Add recommendation.

* Add recommendation.

* Let us catch bad big values in metamodels.

* Deactivate BO test for windows

* Add metamodel in illcond tests.

* fixstaticanalysis

* Lazy initialization in MLTuning (#673)

* Fix discrete mutation in dim 1 (#679)

Co-authored-by: Jeremy Rapin <jrapin@fb.com>
Co-authored-by: Teytaud <oteytaud@fb.com>

* fix

* Add an experimental bouncing bounding method (#684)

* Add a tutorial for windows users (#688)

* Update optimizerlib.py

* updateMetaModel (#692)

* updateMetaModel

* Update optimizerlib.py

Co-authored-by: Jeremy Rapin <jrapin@fb.com>
Co-authored-by: Jérémy Rapin <jrapin.github@gmail.com>
Co-authored-by: Fabien Teytaud <teytaud@lisic.univ-littoral.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Do not delete this pull request or issue due to inactivity.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants