<feed xmlns='http://www.w3.org/2005/Atom'>
<title>delta/python-packages/networkx.git/doc/reference/classes, branch main</title>
<subtitle>github.com: networkx/networkx.git
</subtitle>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/'/>
<entry>
<title>DOC: list pred method for MultiDiGraphs (#6409)</title>
<updated>2023-02-03T16:01:58+00:00</updated>
<author>
<name>Mridul Seth</name>
<email>seth.mridul@gmail.com</email>
</author>
<published>2023-02-03T16:01:58+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=352a38710308067d655d4d0c980d1321475000d5'/>
<id>352a38710308067d655d4d0c980d1321475000d5</id>
<content type='text'>
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
</pre>
</div>
</content>
</entry>
<entry>
<title>plugin based backend infrastructure to use multiple computation backends (#6000)</title>
<updated>2022-11-08T18:39:27+00:00</updated>
<author>
<name>Mridul Seth</name>
<email>seth.mridul@gmail.com</email>
</author>
<published>2022-11-08T18:39:27+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=0f91550007fd3a95261d858b1a6a623ef8bda38a'/>
<id>0f91550007fd3a95261d858b1a6a623ef8bda38a</id>
<content type='text'>
* Wrappers classes to dispatch to a backend

* Rework the backend dispatching

- Use __networkx_plugin__=name to find graph-like objects instead of
  subclassing
- Add PluginInfo to smooth over differences in importlib.metadata across
  python versions
- Add dispatch behavior override via environment variable to aid in
  testing plugins

* Dispatch more algorithms and improve auto-test capabilities

* Allow dispatcher decorator without a name

- Name is taken from the decorated function
- Raise error if backend doesn't implement a decorated function which is called
- Check for duplicate names for dispatching algorithms

* Make sphinx pick up backend docs

* make black happy

* Rename decorator to _dispatch as it's experimental

* A few more dispatched functions

* Make convert to and from methods for auto-testing

- Rename `convert` to `convert_from_nx`
- Add `convert_to_nx` function

These will allow backends to return native objects when dispatching,
but provide a mechanism to convert the result to the type expected
by NetworkX tests for the auto-test plugin mechanism.

* More dispatching

* Include name with `convert_**_nx` methods

* Remove known plugin names

This check is not needed, as any plugin can register itself in the entry points section.
The dispatching and auto-testing explicitly specify the plugin to use, so there is no
need to hardcode the options.
These were originally included for security, but any malicious actor would simply use one
of the valid names, so having a hardcoded list does not actually provide any meaningful
security.

* Add `dispatchname` to dispatchable functions

Co-authored-by: Jim Kitchen &lt;jim22k@gmail.com&gt;
Co-authored-by: Erik Welch &lt;erik.n.welch@gmail.com&gt;</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* Wrappers classes to dispatch to a backend

* Rework the backend dispatching

- Use __networkx_plugin__=name to find graph-like objects instead of
  subclassing
- Add PluginInfo to smooth over differences in importlib.metadata across
  python versions
- Add dispatch behavior override via environment variable to aid in
  testing plugins

* Dispatch more algorithms and improve auto-test capabilities

* Allow dispatcher decorator without a name

- Name is taken from the decorated function
- Raise error if backend doesn't implement a decorated function which is called
- Check for duplicate names for dispatching algorithms

* Make sphinx pick up backend docs

* make black happy

* Rename decorator to _dispatch as it's experimental

* A few more dispatched functions

* Make convert to and from methods for auto-testing

- Rename `convert` to `convert_from_nx`
- Add `convert_to_nx` function

These will allow backends to return native objects when dispatching,
but provide a mechanism to convert the result to the type expected
by NetworkX tests for the auto-test plugin mechanism.

* More dispatching

* Include name with `convert_**_nx` methods

* Remove known plugin names

This check is not needed, as any plugin can register itself in the entry points section.
The dispatching and auto-testing explicitly specify the plugin to use, so there is no
need to hardcode the options.
These were originally included for security, but any malicious actor would simply use one
of the valid names, so having a hardcoded list does not actually provide any meaningful
security.

* Add `dispatchname` to dispatchable functions

Co-authored-by: Jim Kitchen &lt;jim22k@gmail.com&gt;
Co-authored-by: Erik Welch &lt;erik.n.welch@gmail.com&gt;</pre>
</div>
</content>
</entry>
<entry>
<title>Minor doc fixups (#5868)</title>
<updated>2022-07-15T17:58:39+00:00</updated>
<author>
<name>Ross Barnowski</name>
<email>rossbar@berkeley.edu</email>
</author>
<published>2022-07-15T17:58:39+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=e79084b57e1553b5a1e3d80d940acc077ddb771a'/>
<id>e79084b57e1553b5a1e3d80d940acc077ddb771a</id>
<content type='text'>
* Fix examples section formatting in condensed docstr.

* Rm stray reference to ordered grpahs.

* Add naive LCA algs to reference guide.

* Fix heading names in LCA docstrings.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* Fix examples section formatting in condensed docstr.

* Rm stray reference to ordered grpahs.

* Add naive LCA algs to reference guide.

* Fix heading names in LCA docstrings.</pre>
</div>
</content>
</entry>
<entry>
<title>Remove OrderedGraphs (#5813)</title>
<updated>2022-07-12T08:08:34+00:00</updated>
<author>
<name>Jarrod Millman</name>
<email>jarrod.millman@gmail.com</email>
</author>
<published>2022-07-12T08:08:34+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=87393d22b338a53f8f2d68c51b94e30f2ea59e37'/>
<id>87393d22b338a53f8f2d68c51b94e30f2ea59e37</id>
<content type='text'>
Removes the deprecated OrderedGraph classes.

Co-authored-by: Ross Barnowski &lt;rossbar@berkeley.edu&gt;
Co-authored-by: Dan Schult &lt;dschult@colgate.edu&gt;</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
Removes the deprecated OrderedGraph classes.

Co-authored-by: Ross Barnowski &lt;rossbar@berkeley.edu&gt;
Co-authored-by: Dan Schult &lt;dschult@colgate.edu&gt;</pre>
</div>
</content>
</entry>
<entry>
<title>Add coreview objects to documentation (#4431)</title>
<updated>2020-12-07T20:12:46+00:00</updated>
<author>
<name>Ross Barnowski</name>
<email>rossbar@berkeley.edu</email>
</author>
<published>2020-12-07T20:12:46+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=87b92dea2429590c78108d7407f9329cd999a564'/>
<id>87b92dea2429590c78108d7407f9329cd999a564</id>
<content type='text'>
* DOC: Add coreviews to reference guide.

* DOC: Add brief module docstring to coreviews.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* DOC: Add coreviews to reference guide.

* DOC: Add brief module docstring to coreviews.</pre>
</div>
</content>
</entry>
<entry>
<title>Docs update (#4161)</title>
<updated>2020-08-16T04:04:29+00:00</updated>
<author>
<name>Dan Schult</name>
<email>dschult@colgate.edu</email>
</author>
<published>2020-08-16T04:04:29+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=256d1fc47ce440e2f55b16c0d8474f7152a6f68a'/>
<id>256d1fc47ce440e2f55b16c0d8474f7152a6f68a</id>
<content type='text'>
* Fixes #3955 (boundary_expansion docs)

* add to docs for steiner_tree

* Add missing functions to docs. Thanks to #4111

* Doc fixups

* Put filters onto the doc pages.

* Add @jamestrimble doc compare script to repo and expand

* Fix latex syntax in docs for trophic

* more latex corrections

* deprecate edge_betweeness and betweeness_centrality_source.

warnings and add to list of deprecations

* Use docs to identify hopcrfot_karo_matching and maximum_matching

* remove  underscore from _naive_greedy_modularity_communities

* cite James Trimble for code that finds missing functions

* Update parallel_betweenness example to avoid deprecated function

betweenness_centrality_source should be replaced by
betweenness_centrality_subset in plot_parallel_betweenness.

find _naive_greedy and change name

* tweak</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* Fixes #3955 (boundary_expansion docs)

* add to docs for steiner_tree

* Add missing functions to docs. Thanks to #4111

* Doc fixups

* Put filters onto the doc pages.

* Add @jamestrimble doc compare script to repo and expand

* Fix latex syntax in docs for trophic

* more latex corrections

* deprecate edge_betweeness and betweeness_centrality_source.

warnings and add to list of deprecations

* Use docs to identify hopcrfot_karo_matching and maximum_matching

* remove  underscore from _naive_greedy_modularity_communities

* cite James Trimble for code that finds missing functions

* Update parallel_betweenness example to avoid deprecated function

betweenness_centrality_source should be replaced by
betweenness_centrality_subset in plot_parallel_betweenness.

find _naive_greedy and change name

* tweak</pre>
</div>
</content>
</entry>
<entry>
<title>Add method to clear edges only (#3477)</title>
<updated>2020-07-05T07:53:35+00:00</updated>
<author>
<name>Paolo Lammens</name>
<email>lammenspaolo@gmail.com</email>
</author>
<published>2020-07-05T07:53:35+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=87d13e1869d2b3af7ac7d0cdb065044a658e5330'/>
<id>87d13e1869d2b3af7ac7d0cdb065044a658e5330</id>
<content type='text'>
* feat: `clear_edges` in `networkx.Graph`

Method to clear all edges in a graph without altering nodes
or graph attributes. Added corresponding test too.

* tests: improve `test_clear` in `TestGraph`

Added a graph attribute before clearing to test its proper deletion.
too.

* tests: add tests for `clear` and `clear_edges` specific to DiGraph

To test that DiGraph-specific edge records are cleared as well.

* fix: specific `clear_edges` for `DiGraph`

So that DiGraph's pred/succ also get cleared.

* Convert docstrings tests and docs reference links to add clear_edges

Co-authored-by: Dan Schult &lt;dschult@colgate.edu&gt;</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* feat: `clear_edges` in `networkx.Graph`

Method to clear all edges in a graph without altering nodes
or graph attributes. Added corresponding test too.

* tests: improve `test_clear` in `TestGraph`

Added a graph attribute before clearing to test its proper deletion.
too.

* tests: add tests for `clear` and `clear_edges` specific to DiGraph

To test that DiGraph-specific edge records are cleared as well.

* fix: specific `clear_edges` for `DiGraph`

So that DiGraph's pred/succ also get cleared.

* Convert docstrings tests and docs reference links to add clear_edges

Co-authored-by: Dan Schult &lt;dschult@colgate.edu&gt;</pre>
</div>
</content>
</entry>
<entry>
<title>Improved graph class selection table (#3570)</title>
<updated>2019-09-05T01:45:26+00:00</updated>
<author>
<name>Salim BELHADDAD</name>
<email>wangglobal@gmail.com</email>
</author>
<published>2019-09-05T01:45:26+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=bb5742634cfe6d99f4385e9c28417e7a4f7859db'/>
<id>bb5742634cfe6d99f4385e9c28417e7a4f7859db</id>
<content type='text'>
- Suggestion for beginners to make clear that multi(di-)graphs can also have loops.
- Used the word 'allowed' to suggest that the feature is optional.</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
- Suggestion for beginners to make clear that multi(di-)graphs can also have loops.
- Used the word 'allowed' to suggest that the feature is optional.</pre>
</div>
</content>
</entry>
<entry>
<title>Update docs with all functions left out of rst files (#3091)</title>
<updated>2018-07-28T02:47:44+00:00</updated>
<author>
<name>Dan Schult</name>
<email>dschult@colgate.edu</email>
</author>
<published>2018-07-28T02:47:44+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=97b1f07dfc14f59b65df6f6578f1809d912dd86b'/>
<id>97b1f07dfc14f59b65df6f6578f1809d912dd86b</id>
<content type='text'>
* Update docs with all functions not added to rst files

Also add script to find these functions

* put back removed periods after references
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* Update docs with all functions not added to rst files

Also add script to find these functions

* put back removed periods after references
</pre>
</div>
</content>
</entry>
<entry>
<title>Simplify the Graphview and SubGraphView system (#3073)</title>
<updated>2018-07-20T04:53:31+00:00</updated>
<author>
<name>Dan Schult</name>
<email>dschult@colgate.edu</email>
</author>
<published>2018-07-20T04:53:31+00:00</published>
<link rel='alternate' type='text/html' href='http://91.123.203.49/cgit/delta/python-packages/networkx.git/commit/?id=e46f4c1cc02feaa08c855ca211ef114acc8fd772'/>
<id>e46f4c1cc02feaa08c855ca211ef114acc8fd772</id>
<content type='text'>
* Simplify the Graphview and SubGraphView system

- add tests to show that extensions of base graph classes (only add new functions)
  should be able to use the Graph.subgraph and Graph.copy methods easily
- Remove ReadOnlyGraph class in favor of existing freeze() function
- Switch all GraphView classes to generic_graph_view function
- Switch all SubGraph classes to subgraph_view function
- Introduce deprecated functions that act like the deprecated classes.

Still need to:
- add docs
- add tests
- make sure backward compatible and marked as deprecated
- remove GraphView and SubGraph construct from rest of codebase
- update release docs

Fixes #2889
Fixes #2793
Fixes #2796
Fixes #2741

* Ease subclassing for to_(un)directed

- add to_directed_class indicator functions to base classes
- start deprecating G.fresh_copy
- update function.to(un)directed

* Remove G.fresh_copy from code replace with __class__

Add deprecation warnings for GraphView classes, ReverseView and
SubGraph. Also for fresh_copy function.
</content>
<content type='xhtml'>
<div xmlns='http://www.w3.org/1999/xhtml'>
<pre>
* Simplify the Graphview and SubGraphView system

- add tests to show that extensions of base graph classes (only add new functions)
  should be able to use the Graph.subgraph and Graph.copy methods easily
- Remove ReadOnlyGraph class in favor of existing freeze() function
- Switch all GraphView classes to generic_graph_view function
- Switch all SubGraph classes to subgraph_view function
- Introduce deprecated functions that act like the deprecated classes.

Still need to:
- add docs
- add tests
- make sure backward compatible and marked as deprecated
- remove GraphView and SubGraph construct from rest of codebase
- update release docs

Fixes #2889
Fixes #2793
Fixes #2796
Fixes #2741

* Ease subclassing for to_(un)directed

- add to_directed_class indicator functions to base classes
- start deprecating G.fresh_copy
- update function.to(un)directed

* Remove G.fresh_copy from code replace with __class__

Add deprecation warnings for GraphView classes, ReverseView and
SubGraph. Also for fresh_copy function.
</pre>
</div>
</content>
</entry>
</feed>
