Skip to content

Commit

Permalink
Document numpy 2.0.0 issue in troubleshooting page; add discord commu…
Browse files Browse the repository at this point in the history
…nity welcome in main web page.
  • Loading branch information
seanzhangkx8 committed Nov 20, 2024
1 parent c683cd7 commit be449f5
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

This toolkit contains tools to extract conversational features and analyze social phenomena in conversations, using a [single unified interface](https://convokit.cornell.edu/documentation/architecture.html) inspired by (and compatible with) scikit-learn. Several large [conversational datasets](https://github.com/CornellNLP/ConvoKit#datasets) are included together with scripts exemplifying the use of the toolkit on these datasets. The latest version is [3.0.1](https://github.com/CornellNLP/ConvoKit/releases/tag/v3.0.1) (released November 19, 2024); follow the [project on GitHub](https://github.com/CornellNLP/ConvoKit) to keep track of updates.

Join our [Discord community](https://discord.gg/WMFqMWgz6P) to stay informed, connect with fellow developers, and be part of an engaging space where we share progress, discuss features, and tackle issues together.

Read our [documentation](https://convokit.cornell.edu/documentation) or try ConvoKit in our [interactive tutorial](https://colab.research.google.com/github/CornellNLP/ConvoKit/blob/master/examples/Introduction_to_ConvoKit.ipynb).

The toolkit currently implements features for:
Expand Down
32 changes: 26 additions & 6 deletions docs/source/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,32 @@ General checks
Issues
^^^^^^

**Error associated with Numpy**
**Error Associated with Numpy 2.0.0**

Pre Spacy 3.8.2 is not compatible with numpy 2.0.0+ due to compatibility issues with thinc. Spacy 3.8.2 is compatible with numpy 2.0.0+ but currently requires thinc to be >=8.3.0, <8.4.0, so as a temporary solution ConvoKit now enforces spacy>=3.8.2, thinc >=8.3.0, <8.4.0. We will continue to keep an eye on spacy releases and update the requirements if there are new releases targeting this issue.
For additional insight into the issue:
`spaCy issue #13528 <https://github.com/explosion/spaCy/issues/13528>`_
`thinc issue #939 <https://github.com/explosion/thinc/issues/939>`_
The release of `numpy 2.0.0 <https://numpy.org/devdocs/release/2.0.0-notes.html>`_ is exciting,
yet it breaks backward compatibility for packages that are built with numpy 1.x.
While our new release (ConvoKit 3.0.1) addresses the problem and is built against the new numpy,
there are ConvoKit dependency packages that still experience issues with numpy 2.0.0+.
We have fixed known errors from testing, but the tests are far from exhaustive.
Therefore, if you face an error likely triggered by adapting to numpy 2.0.0+ versions,
we encourage you to please submit an issue on our GitHub, so we can address the problem as soon as possible. Thank you!

For explanations of what errors numpy 2.0 could cause on packages that are not built against it,
check the `numpy 2.0 migration guide <https://numpy.org/devdocs/numpy_2_0_migration_guide.html>`_.

An example of an issue that we fixed is demonstrated below:

Pre-Spacy 3.8.2 is not compatible with numpy 2.0.0+ due to compatibility issues with thinc.
Spacy 3.8.2 is compatible with numpy 2.0.0+ but currently requires thinc to be >=8.3.0, <8.4.0.
As a temporary solution, ConvoKit now enforces spacy>=3.8.2, thinc >=8.3.0, <8.4.0.
We will continue to monitor spacy releases and update the requirements if there are new releases targeting this issue.

For additional information about the issue, see:
`spaCy issue <https://github.com/explosion/spaCy/issues/13528>`_,
`thinc issue <https://github.com/explosion/thinc/issues/939>`_.

The issues are more likely to appear when you install ConvoKit in an existing environment where other packages have already been pre-installed.
Installing ConvoKit in a new environment following our installation guide should result in no errors.

-----------------------------

Expand Down Expand Up @@ -70,7 +90,7 @@ and if that doesn't fix the issue, then run:

>>> open /Applications/Python\ 3.10/Install\ Certificates.command

(Substitute 3.10 in the above command with your current Python version (e.g. 3.11 or 3.12) if necessary.)
(Substitute 3.10 in the above command with your current Python version (e.g. 3.11 or 3.12 or 3.13) if necessary.)

Immutability of Metadata Fields
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit be449f5

Please sign in to comment.