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

Revisit and update documentation and examples #389

Open
ljvmiranda921 opened this issue Apr 20, 2020 · 8 comments
Open

Revisit and update documentation and examples #389

ljvmiranda921 opened this issue Apr 20, 2020 · 8 comments
Assignees
Labels
documentation Documentation improvements or fixes tech-debt Related issues for improving baseline Pyswarms performance and documentation this 2020

Comments

@ljvmiranda921
Copy link
Owner

ljvmiranda921 commented Apr 20, 2020

I think one of the more common issues we encounter is that some examples don't work out of the box. We may have introduced a lot of changes in the API from the previous versions and weren't able to update the docs properly.

Let's scope this one out, right now we have docs located in:

  • Our docstrings
  • Jupyter notebooks

I know we did this exercise before, but it may be good to revisit it again just to be really sure that everything is working well.

Let me know what you think @whzup @stevenbw

@ljvmiranda921 ljvmiranda921 added the documentation Documentation improvements or fixes label Apr 20, 2020
@ljvmiranda921 ljvmiranda921 self-assigned this Apr 20, 2020
@ljvmiranda921 ljvmiranda921 pinned this issue Apr 20, 2020
@ljvmiranda921 ljvmiranda921 added the tech-debt Related issues for improving baseline Pyswarms performance and documentation this 2020 label Apr 20, 2020
@whzup
Copy link
Collaborator

whzup commented Apr 21, 2020

I found some unrendered math here.

@whzup
Copy link
Collaborator

whzup commented Apr 21, 2020

I also think we should open an issue for a collection of architecture updates we want to make (e.g. see #235, #259).

@ljvmiranda921
Copy link
Owner Author

ljvmiranda921 commented Apr 21, 2020

^Agree! Or we can just reuse the existing issues #235 #259 and include them in this current effort.
Also @whzup , no pressure here, I appreciate that you're taking the time and holding the fort answering Issues and reviewing PRs, but focus on your thesis and graduation! I'm rooting for you!

@msat59
Copy link
Contributor

msat59 commented May 1, 2020

I think one of the more common issues we encounter is that some examples don't work out of the box. We may have introduced a lot of changes in the API from the previous versions and weren't able to update the docs properly.

Let's scope this one out, right now we have docs located in:

  • Our docstrings
  • Jupyter notebooks

I know we did this exercise before, but it may be good to revisit it again just to be really sure that everything is working well.

Let me know what you think @whzup @stevenbw

In case of a n_process>2, an addition consideration must be given to Jupyter Notebook for windows users.

https://stackoverflow.com/questions/47313732/jupyter-notebook-never-finishes-processing-using-multiprocessing-python-3

@whzup
Copy link
Collaborator

whzup commented May 4, 2020

@whzup whzup mentioned this issue May 5, 2020
9 tasks
@whzup
Copy link
Collaborator

whzup commented May 5, 2020

@ljvmiranda921 Do you think it would be a good idea to build a MWE for a custom optimizer in Writing your own optimization loop?

@ljvmiranda921
Copy link
Owner Author

^Ooooh, you meant like a scaffold of it? @whzup yeah that would be good to be honest. I think just describing what it looks like (what I did) isn't enough

@svhoy
Copy link

svhoy commented Feb 17, 2024

Hello,

I am currently like to work with pyswarms and had a look in your Documentation. In your example Electric circuit problem is an false result in your section Setting the optimizer.

The results are:

[5]: print(pos[0])
0.23426529444241187

[6]: print(cost)
14.045352861989468

But later you talk about 0.094A, which I can confirm when running the code local in my notebook. This made me a little bit confiused when reading the docs.

if it is desired I can create a pull request with the correction.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation improvements or fixes tech-debt Related issues for improving baseline Pyswarms performance and documentation this 2020
Projects
None yet
Development

No branches or pull requests

4 participants