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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update example notebooks #264

Open
ljvmiranda921 opened this Issue Jan 30, 2019 · 21 comments

Comments

Projects
None yet
6 participants
@ljvmiranda921
Copy link
Owner

ljvmiranda921 commented Jan 30, 2019

After releasing v0.4.0, it seems that we already had some API changes that were not reflected in the notebook. What you need to do is just rerun all the notebooks in this link and update the code as necessary to account for API changes 馃憤

@adrish96

This comment has been minimized.

Copy link

adrish96 commented Jan 30, 2019

Can you give some more details as to how do I get started with this?

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Jan 30, 2019

Hi @adrish96 ! Welcome to Pyswarms!

The first step is to fork this repository and create your own branch. Clone your branch, then head over to pyswarms/examples and you'll see a bunch of jupyter notebooks.

For each notebook

  • Just try running the cells inside it
  • If there's an error, then that means an API has been changed (for example, we're using sphere_func before but now it's just sphere. Calling sphere_func in the notebook` will cause an error)
  • Then, just change whatever is in the notebooks so that it works again.

For more information, check our contributing guide!

@fluencer

This comment has been minimized.

Copy link

fluencer commented Jan 30, 2019

@ljvmiranda921 I am running the notebooks. I cloned the repo and installed the pyswarms library as specified in the readme. But I get the error 'yaml' not found at the line import yaml. Is this the library I have to use? https://pyyaml.org/wiki/PyYAMLDocumentation

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Jan 30, 2019

Hi @fluencer ! Yes that's the library to use 馃槃

@fluencer

This comment has been minimized.

Copy link

fluencer commented Jan 30, 2019

@ljvmiranda921 I made changes to the basic_optimization.ipynb notebook and I want to push it. But I am denied access. I am a first-timer so I am not sure what to do.

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Jan 30, 2019

Hey @fluencer, you should fork this repo first then clone your own fork :) check my comments above and in the contributing guidelines :)

@Chimdiya1

This comment has been minimized.

Copy link

Chimdiya1 commented Jan 30, 2019

pyswarms/examples does not exist

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Jan 31, 2019

Oops @Chimdiya1 , so sorry, it should just be in ./examples.

Also, I realized that there are three people working in this issue, how about we divide the tasks?
Since the first one's already been PR'd, how about:

@fluencer

  • custom_optimization_loop.ipynb

@adrish96

  • feature_subset_selection.ipynb
  • train_neural_network.ipynb

@Chimdiya1

  • inverse_kinematics.ipynb
  • visualization.ipynb

Just reply or 馃憤 if this arrangement is good. After two days and if no one has owned some notebooks, then @fluencer (since he already has a pull request) can take the unclaimed ones. 馃槃

@konstunn

This comment has been minimized.

Copy link

konstunn commented Feb 1, 2019

Where are pull-requests? How is it all going?

@fluencer

This comment has been minimized.

Copy link

fluencer commented Feb 2, 2019

Where are pull-requests? How is it all going?

I have finished that were allotted to me. Can I work on the rest and push them along too?

@adrish96

This comment has been minimized.

Copy link

adrish96 commented Feb 2, 2019

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Feb 2, 2019

Hi @fluencer, i think @Chimdiya1 and @adrish96 will claim the other notebooks. So it鈥檚 all good now, I鈥檒l check your PR and merge them this weekend!

@Chimdiya1

This comment has been minimized.

Copy link

Chimdiya1 commented Feb 3, 2019

Where are pull-requests? How is it all going?

I have finished that were allotted to me. Can I work on the rest and push them along too?

could you brief me on how you did it?

@adrish96

This comment has been minimized.

Copy link

adrish96 commented Feb 4, 2019

I have a few doubts,

  1. is 'git checkout -b ' on the command line same as clicking the 'branch ' tab on the github website?
  2. I cloned the project and installed it according to the contributing guidelines, it was successful, I then initiated the jupyter notebooks from the conda command line, I was unable to 'import pyswarms as ps', how can I resolve this?
    I'm a total beginner and this is my first attempt at contributing to OSS, I apologize for the silly questions.
@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Feb 4, 2019

Hi @adrish96

  1. As far as I know, it's not. git checkout -b makes sure that the files in your local repository will be in the state of the target branch. I hope this made sense 馃槃
  2. Would you mind copying the full error here?
@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Feb 4, 2019

Hi @Chimdiya1

The first step is to fork this repository and create your own branch. Clone your branch, then head over to pyswarms/examples and you'll see a bunch of jupyter notebooks.

For each notebook

  • Just try running the cells inside it
  • If there's an error, then that means an API has been changed (for example, we're using sphere_func before but now it's just sphere. Calling sphere_func in the notebook` will cause an error)
  • Then, just change whatever is in the notebooks so that it works again.

For more information, check our contributing guide!

@pmk21

This comment has been minimized.

Copy link

pmk21 commented Feb 7, 2019

New to open source and I'd like to contribute, but seems like work has already been allotted.
Can I still contribute to this issue?

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Feb 8, 2019

Hi @pmk21 , I'm afraid all notebooks in this Issue have been taken. We'll open up a new first-timers issue soon though!

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Feb 12, 2019

Hi, @fluencer , it seems that the others haven't made progress with their own notebooks. Would you like to do those as well?

For @adrish96 and @Chimdiya1 , you can probably try updating the README or anything?

@adrish96

This comment has been minimized.

Copy link

adrish96 commented Feb 12, 2019

I really have the desire to work on the Jupyter notebooks, work has been so hectic off late, damn! I'll give it another go this evening :)

@ljvmiranda921

This comment has been minimized.

Copy link
Owner Author

ljvmiranda921 commented Feb 12, 2019

Ok sure, it's good to give confirmation! Ok, will reserve that for you @adrish96 , cc: @fluencer

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment