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

Updates github org name #285

Merged
merged 4 commits into from
Aug 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ authors:
given-names: Xinyuan
orcid: "https://orcid.org/0000-0003-1770-631X"
doi: 10.5281/zenodo.10151130
repository-code: "https://github.com/LabForComputationalVision/plenoptic"
repository-code: "https://github.com/plenoptic-org/plenoptic"
url: "https://plenoptic.readthedocs.io/"
license: MIT
keywords:
Expand Down
28 changes: 14 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ overview of the project and how to get everything installed, as well as pointers
for further reading, depending on your interests.

If you encounter any issues with `plenoptic`, first search the existing
[issues](https://github.com/LabForComputationalVision/plenoptic/issues) and
[discussions](https://github.com/LabForComputationalVision/plenoptic/discussions)
[issues](https://github.com/plenoptic-org/plenoptic/issues) and
[discussions](https://github.com/plenoptic-org/plenoptic/discussions)
to see if there's already information to help you. If not, please open a new
[issue](https://github.com/LabForComputationalVision/plenoptic/issues)! We have
[issue](https://github.com/plenoptic-org/plenoptic/issues)! We have
a template for bug reports, and following it (so you provide the necessary
details) will make solving your problem much easier.

Expand All @@ -23,26 +23,26 @@ familiar with the project, it can be very helpful for us if you go through the
tutorials, README, and documentation and let us know if anything is unclear,
what needs more detail (or clearer writing), etc. For those that want to
contribute code, we also have many
[issues](https://github.com/LabForComputationalVision/plenoptic/issues) that we
[issues](https://github.com/plenoptic-org/plenoptic/issues) that we
are working through. If you would like to work on one of those, please give it a
try!

In order to submit changes, create a branch or fork of the project, make your
changes, add documentation and tests, and submit a [Pull
Request](https://github.com/LabForComputationalVision/plenoptic/pulls). See
Request](https://github.com/plenoptic-org/plenoptic/pulls). See
[contributing to the code below](#contributing-to-the-code) for more details on
this process.

We try to keep all our communication on Github, and we use several channels:

- [Discussions](https://github.com/LabForComputationalVision/plenoptic/discussions)
- [Discussions](https://github.com/plenoptic-org/plenoptic/discussions)
is the place to ask usage questions, discuss issues too broad for a
single issue, or show off what you've made with plenoptic.
- If you've come across a bug, open an
[issue](https://github.com/LabForComputationalVision/plenoptic/issues).
[issue](https://github.com/plenoptic-org/plenoptic/issues).
- If you have an idea for an extension or enhancement, please post in the
[ideas
section](https://github.com/LabForComputationalVision/plenoptic/discussions/categories/ideas)
section](https://github.com/plenoptic-org/plenoptic/discussions/categories/ideas)
of discussions first. We'll discuss it there and, if we decide to pursue it,
open an issue to track progress.

Expand Down Expand Up @@ -74,15 +74,15 @@ increments the version number, and uploading the new release to PyPI (see

In addition to the information that follows, [Github](https://docs.github.com/en/get-started/quickstart/github-flow) (unsurprisingly) has good information on this workflow, as does the [Caiman package](https://github.com/flatironinstitute/CaImAn/blob/main/CONTRIBUTING.md) (though note that the Caiman uses **git** flow, which involves a separate develop branch in addition to main).

Before we begin: everyone finds `git` confusing the first few (dozen) times they encounter it! And even people with a hard-won understanding frequently look up information on how it works. If you find the following difficult, we're happy to help walk you through the process. Please [post on our GitHub discussions page](https://github.com/LabForComputationalVision/plenoptic/discussions) to get help.
Before we begin: everyone finds `git` confusing the first few (dozen) times they encounter it! And even people with a hard-won understanding frequently look up information on how it works. If you find the following difficult, we're happy to help walk you through the process. Please [post on our GitHub discussions page](https://github.com/plenoptic-org/plenoptic/discussions) to get help.

#### Creating a development environment

You'll need a local installation of `plenoptic` which keeps up-to-date with any changes you make. To do so, you will need to fork and clone `plenoptic`:

1. Go to the [plenoptic repo](https://github.com/LabForComputationalVision/plenoptic/) and click on the `Fork` button at the top right of the page. This creates a copy of plenoptic in your Github account.
2. You should then clone *your fork* to your local machine and create an editable installation. To do so, follow the instructions for an editable install found in our [docs](https://plenoptic.readthedocs.io/en/latest/install.html#installation), replacing `git clone https://github.com/LabForComputationalVision/plenoptic.git` with `git clone https://github.com/<YourUserName>/plenoptic.git`.
3. Add the `upstream` branch: `git remote add upstream https://github.com/LabForComputationalVision/plenoptic.git`. At this point, you have two remotes: `origin` (your fork) and `upstream` (the canonical version). You won't have permission to push to upstream (only `origin`), but this makes it easy to keep your `plenoptic` up to date with the canonical version by pulling from upstream: `git pull upstream`.
1. Go to the [plenoptic repo](https://github.com/plenoptic-org/plenoptic/) and click on the `Fork` button at the top right of the page. This creates a copy of plenoptic in your Github account.
2. You should then clone *your fork* to your local machine and create an editable installation. To do so, follow the instructions for an editable install found in our [docs](https://plenoptic.readthedocs.io/en/latest/install.html#installation), replacing `git clone https://github.com/plenoptic-org/plenoptic.git` with `git clone https://github.com/<YourUserName>/plenoptic.git`.
3. Add the `upstream` branch: `git remote add upstream https://github.com/plenoptic-org/plenoptic.git`. At this point, you have two remotes: `origin` (your fork) and `upstream` (the canonical version). You won't have permission to push to upstream (only `origin`), but this makes it easy to keep your `plenoptic` up to date with the canonical version by pulling from upstream: `git pull upstream`.

You should probably also install all the optional dependencies, so that you can run tests, build the documentation, and run the jupyter notebooks locally. To do so, run `pip install -e .[docs,dev,nb]` from within the copy of `plenoptic` on your machine (see [this section](https://plenoptic.readthedocs.io/en/latest/install.html#jupyter) of our documentation for information on how to set up jupyter if you don't want an extra copy of it in this environment).

Expand Down Expand Up @@ -157,7 +157,7 @@ versioning](https://semver.org/):
When doing a new release, the following steps must be taken:
1. In a new PR:
- Update all the [binder](https://mybinder.org) links, which are of the form
`https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/X.Y.Z?filepath=examples`,
`https://mybinder.org/v2/gh/plenoptic-org/plenoptic/X.Y.Z?filepath=examples`,
which are found in `README.md`, `index.rst`, `examples/README.md`, and some
of the tutorial notebooks found in `examples/`. Note that the version tag
must match the github tag (specified in the next step) or the link won't
Expand Down Expand Up @@ -196,7 +196,7 @@ several choices for how to run a subset of the tests:
- Another example specifying a test method in the command line: `pytest
test_mod.py::TestClass::test_method`

View the [pytest documentation](http://doc.pytest.org/en/latest/usage.html) for
View the [pytest documentation](https://doc.pytest.org/en/latest/usage.html) for
more info.

### Adding tests
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

[![PyPI Version](https://img.shields.io/pypi/v/plenoptic.svg)](https://pypi.org/project/plenoptic/)
[![Anaconda-Server Badge](https://anaconda.org/conda-forge/plenoptic/badges/version.svg)](https://anaconda.org/conda-forge/plenoptic)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/LabForComputationalVision/plenoptic/blob/main/LICENSE)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/plenoptic-org/plenoptic/blob/main/LICENSE)
![Python version](https://img.shields.io/badge/python-3.10|3.11|3.12-blue.svg)
[![Build Status](https://github.com/LabForComputationalVision/plenoptic/workflows/build/badge.svg)](https://github.com/LabForComputationalVision/plenoptic/actions?query=workflow%3Abuild)
[![Build Status](https://github.com/plenoptic-org/plenoptic/workflows/build/badge.svg)](https://github.com/plenoptic-org/plenoptic/actions?query=workflow%3Abuild)
[![Documentation Status](https://readthedocs.org/projects/plenoptic/badge/?version=latest)](https://plenoptic.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10151131.svg)](https://doi.org/10.5281/zenodo.10151131)
[![codecov](https://codecov.io/gh/LabForComputationalVision/plenoptic/branch/main/graph/badge.svg?token=EDtl5kqXKA)](https://codecov.io/gh/LabForComputationalVision/plenoptic)
[![Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/LabForComputationalVision/plenoptic/1.0.1?filepath=examples)
[![codecov](https://codecov.io/gh/plenoptic-org/plenoptic/branch/main/graph/badge.svg?token=EDtl5kqXKA)](https://codecov.io/gh/plenoptic-org/plenoptic)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/plenoptic-org/plenoptic/1.0.1?filepath=examples)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

![](docs/images/plenoptic_logo_wide.svg)
Expand Down Expand Up @@ -55,7 +55,7 @@ Our dependencies include [pytorch](https://pytorch.org/) and
care of them (along with our other dependencies) automatically, but if you have
an installation problem (especially on a non-Linux operating system), it is
likely that the problem lies with one of those packages. [Open an
issue](https://github.com/LabForComputationalVision/plenoptic/issues) and we'll
issue](https://github.com/plenoptic-org/plenoptic/issues) and we'll
try to help you figure out the problem!

See the [installation
Expand Down Expand Up @@ -137,14 +137,14 @@ with a random string, `matplotlib` will tell you the available choices.

We communicate via several channels on Github:

- [Discussions](https://github.com/LabForComputationalVision/plenoptic/discussions)
- [Discussions](https://github.com/plenoptic-org/plenoptic/discussions)
is the place to ask usage questions, discuss issues too broad for a
single issue, or show off what you've made with plenoptic.
- If you've come across a bug, open an
[issue](https://github.com/LabForComputationalVision/plenoptic/issues).
[issue](https://github.com/plenoptic-org/plenoptic/issues).
- If you have an idea for an extension or enhancement, please post in the
[ideas
section](https://github.com/LabForComputationalVision/plenoptic/discussions/categories/ideas)
section](https://github.com/plenoptic-org/plenoptic/discussions/categories/ideas)
of discussions first. We'll discuss it there and, if we decide to pursue it,
open an issue to track progress.
- See the [contributing guide](CONTRIBUTING.md) for how to get involved.
Expand Down Expand Up @@ -190,4 +190,4 @@ for Computational Neuroscience.
2019](https://proceedings.neurips.cc/paper_files/paper/2019/hash/ac27b77292582bc293a51055bfc994ee-Abstract.html),
though we haven't yet implemented examples. If you're interested, please
post in
[Discussions](https://github.com/LabForComputationalVision/plenoptic/discussions)!
[Discussions](https://github.com/plenoptic-org/plenoptic/discussions)!
7 changes: 4 additions & 3 deletions docs/conceptual_intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -231,17 +231,18 @@ predictions to test.
<https://proceedings.neurips.cc/paper_files/paper/2019/hash/ac27b77292582bc293a51055bfc994ee-Abstract.html>`_
though we haven't yet implemented examples. If you're interested, please
post in `Discussions
<https://github.com/LabForComputationalVision/plenoptic/discussions)>`_!
<https://github.com/plenoptic-org/plenoptic/discussions)>`_!
.. [#] for example, as of February 2022, more than 100 models have above 95% top
5 accuracy on ImageNet, with 9 models within a percent of the top performer at
99.02%. Furthermore, the state of the art top 5 accuracy has been at or above
95% since 2016, with an improvement of only 4% in the past six years.

.. [Helmholtz1852] Helmholtz, H. (1852). LXXXI. on the theory of compound
colours. The London, Edinburgh, and Dublin Philosophical Magazine and Journal
of Science, 4(28), 519–534. http://dx.doi.org/10.1080/14786445208647175
of Science, 4(28), 519–534. https://dx.doi.org/10.1080/14786445208647175
.. [Lettvin1976] Lettvin, J. Y. (1976). On Seeing Sidelong. The Sciences, 16(4),
10–20. http://jerome.lettvin.com/jerome/OnSeeingSidelong.pdf
10–20.
https://web.archive.org/web/20221016220044/https://jerome.lettvin.com/jerome/OnSeeingSidelong.pdf
.. [Szegedy2013] Szegedy, C., Zaremba, W., Sutskever, I., Bruna, J., Erhan, D.,
Goodfellow, I., & Fergus, R. (2013). Intriguing properties of neural
networks. https://arxiv.org/abs/1312.6199
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# http://www.sphinx-doc.org/en/master/config
# https://www.sphinx-doc.org/en/master/config

# -- Path setup --------------------------------------------------------------

Expand Down
Loading