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

refactor: Reorganized references folder #104

Merged
merged 14 commits into from
Mar 1, 2021

Conversation

MateoLostanlen
Copy link
Member

The purpose of this PR is to close #103

@MateoLostanlen MateoLostanlen added the ext: references Related to references label Feb 13, 2021
@MateoLostanlen MateoLostanlen self-assigned this Feb 13, 2021
@MateoLostanlen MateoLostanlen added this to In progress in PyroNear kanban via automation Feb 13, 2021
@codecov
Copy link

codecov bot commented Feb 13, 2021

Codecov Report

Merging #104 (d788d0f) into master (217d461) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #104   +/-   ##
=======================================
  Coverage   92.33%   92.33%           
=======================================
  Files          18       18           
  Lines         652      652           
=======================================
  Hits          602      602           
  Misses         50       50           
Flag Coverage Δ
unittests 92.33% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 217d461...fe18ac4. Read the comment docs.

@frgfm frgfm changed the title reorganize references folder refactor: Reorganized references folder Feb 13, 2021
@frgfm frgfm added the type: enhancement New feature or request label Feb 13, 2021
@frgfm frgfm added this to the 0.1.1 milestone Feb 13, 2021
Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! While I agree the priority should be set to WildFire, considering the dataset version we use for training is not yet available publicly in the lib, I suggest keeping the OpenFire training by merging the two scripts (having an option pointing to the dataset the user wants to train on, wildfire/lightfire by default). What do you think?

@MateoLostanlen
Copy link
Member Author

ok I understand your point I'll make the change

@MateoLostanlen
Copy link
Member Author

Hi fg, I added the possibility to train a model with openfire. We need to make Wildfire downloadable in the same way (with a flag download=True) in a futur PR.

@MateoLostanlen
Copy link
Member Author

There is an issue with doc build, there is already an open issue on the repo : sphinx-doc/sphinx#8885

Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

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

Small last change and we're good to go!

references/classification/train.py Outdated Show resolved Hide resolved
references/classification/README.md Outdated Show resolved Hide resolved
PyroNear kanban automation moved this from In progress to Review in progress Feb 14, 2021
@frgfm
Copy link
Member

frgfm commented Feb 15, 2021

Watch out not to mix PR purposes together, I just noticed that you removed utils.rst in the documentation. This should be done in a separate PR as this is a completely different topic, I'll open one to handle this quickly 👌

Best practices:

  • 1PR = 1 goal
  • the goal should be put in the title, and the description should explain exhaustively all modifications

Otherwise it gets very hard quickly to track back past modifications :/

Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

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

All good, I think you merged unwanted modifications as well (cf. comments). But it's really nitpicking

references/classification/train.py Outdated Show resolved Hide resolved
references/classification/train.py Outdated Show resolved Hide resolved
Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

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

Sorry my previous feedback wasn't clear apparently 😅

references/classification/train.py Outdated Show resolved Hide resolved
references/classification/train.py Outdated Show resolved Hide resolved
@frgfm
Copy link
Member

frgfm commented Feb 17, 2021

Also, I didn't realize, but you have to update the instructions of the "References" section in the main README ;)

README.md Outdated Show resolved Hide resolved
Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

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

One last typo, and we can merge 😅

README.md Outdated Show resolved Hide resolved
@frgfm frgfm modified the milestones: 0.1.1, 0.1.2 Feb 28, 2021
frgfm
frgfm previously approved these changes Feb 28, 2021
Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

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

Looks good to me! Seems like you'll need to merge master before moving on though

PyroNear kanban automation moved this from Review in progress to Reviewer approved Feb 28, 2021
PyroNear kanban automation moved this from Reviewer approved to Review in progress Mar 1, 2021
PyroNear kanban automation moved this from Review in progress to Reviewer approved Mar 1, 2021
Copy link
Member

@frgfm frgfm left a comment

Choose a reason for hiding this comment

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

Thanks for the edits!

@MateoLostanlen MateoLostanlen merged commit aab603e into pyronear:master Mar 1, 2021
PyroNear kanban automation moved this from Reviewer approved to Done Mar 1, 2021
@MateoLostanlen MateoLostanlen deleted the reorganize_references branch June 7, 2021 07:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: references Related to references type: enhancement New feature or request
Projects
Development

Successfully merging this pull request may close these issues.

[reference] Reorganize reference folder
2 participants