feat: Add discovery stubs and documentation for IGraphs.jl integration (#446)

[mahmudsudo]

closes #446
see :
JuliaGraphs/IGraphs.jl#43
JuliaGraphs/IGraphs.jl#44
JuliaGraphs/IGraphs.jl#45

[github-actions]

Benchmark Results (Julia v1)

Time benchmarks

	master	884b277...	master / 884b277...
centrality/digraphs/betweenness_centrality	16.9 ± 0.65 ms	16.6 ± 0.65 ms	1.02 ± 0.056
centrality/digraphs/closeness_centrality	12.1 ± 0.86 ms	11.6 ± 0.64 ms	1.04 ± 0.093
centrality/digraphs/degree_centrality	2.08 ± 1.5 μs	1.96 ± 0.17 μs	1.06 ± 0.78
centrality/digraphs/katz_centrality	0.878 ± 0.063 ms	0.881 ± 0.057 ms	0.996 ± 0.096
centrality/digraphs/pagerank	0.0366 ± 0.0045 ms	0.0363 ± 0.00061 ms	1.01 ± 0.13
centrality/graphs/betweenness_centrality	29 ± 1.5 ms	29 ± 1.4 ms	1 ± 0.071
centrality/graphs/closeness_centrality	21.4 ± 0.49 ms	21.5 ± 0.49 ms	0.996 ± 0.032
centrality/graphs/degree_centrality	1.52 ± 0.17 μs	1.5 ± 0.17 μs	1.01 ± 0.16
centrality/graphs/katz_centrality	1.03 ± 0.051 ms	1.05 ± 0.059 ms	0.979 ± 0.074
connectivity/digraphs/strongly_connected_components	0.043 ± 0.0021 ms	0.043 ± 0.0011 ms	1 ± 0.055
connectivity/graphs/connected_components	24.4 ± 1.1 μs	24.2 ± 0.77 μs	1.01 ± 0.055
core/edges/digraphs	7.02 ± 0.01 μs	7.01 ± 0.019 μs	1 ± 0.0031
core/edges/graphs	17 ± 0.09 μs	15.7 ± 0.19 μs	1.08 ± 0.014
core/has_edge/digraphs	5.28 ± 0.47 μs	5.2 ± 0.37 μs	1.02 ± 0.12
core/has_edge/graphs	5.7 ± 0.88 μs	5.61 ± 0.4 μs	1.02 ± 0.17
core/nv/digraphs	0.361 ± 0.01 μs	0.361 ± 0.01 μs	1 ± 0.039
core/nv/graphs	0.381 ± 0.001 μs	0.391 ± 0.01 μs	0.974 ± 0.025
edges/fille	8.63 ± 1.1 μs	8.66 ± 1.3 μs	0.996 ± 0.2
edges/fillp	5.53 ± 4.2 μs	5.69 ± 3.7 μs	0.972 ± 0.97
edges/tsume	2.6 ± 0.11 μs	2.54 ± 0.08 μs	1.02 ± 0.054
edges/tsump	2.48 ± 0.021 μs	2.54 ± 0.07 μs	0.98 ± 0.028
insertions/SG(n,e) Generation	25.7 ± 3.2 ms	25.2 ± 3.1 ms	1.02 ± 0.18
parallel/egonet/twohop	0.312 ± 0.026 s	0.318 ± 0.025 s	0.982 ± 0.11
parallel/egonet/vertexfunction	2.5 ± 0.51 ms	2.51 ± 0.44 ms	0.999 ± 0.27
serial/egonet/twohop	0.312 ± 0.024 s	0.318 ± 0.024 s	0.982 ± 0.11
serial/egonet/vertexfunction	2.37 ± 0.44 ms	2.48 ± 0.44 ms	0.959 ± 0.25
traversals/digraphs/bfs_tree	0.0502 ± 0.012 ms	0.0494 ± 0.0024 ms	1.02 ± 0.25
traversals/digraphs/dfs_tree	0.0645 ± 0.011 ms	0.0637 ± 0.0026 ms	1.01 ± 0.18
traversals/graphs/bfs_tree	0.0538 ± 0.0026 ms	0.053 ± 0.0017 ms	1.02 ± 0.058
traversals/graphs/dfs_tree	0.0666 ± 0.0049 ms	0.0658 ± 0.002 ms	1.01 ± 0.081
time_to_load	0.536 ± 0.0075 s	0.553 ± 0.018 s	0.968 ± 0.035

Memory benchmarks

	master	884b277...	master / 884b277...
centrality/digraphs/betweenness_centrality	0.29 M allocs: 24 MB	0.29 M allocs: 24 MB	1
centrality/digraphs/closeness_centrality	18.6 k allocs: 14.5 MB	18.6 k allocs: 14.5 MB	1
centrality/digraphs/degree_centrality	8 allocs: 5.01 kB	8 allocs: 5.01 kB	1
centrality/digraphs/katz_centrality	2.63 k allocs: 2.83 MB	2.63 k allocs: 2.83 MB	1
centrality/digraphs/pagerank	21 allocs: 14.9 kB	21 allocs: 14.9 kB	1
centrality/graphs/betweenness_centrality	0.545 M allocs: 0.0313 GB	0.545 M allocs: 0.0313 GB	1
centrality/graphs/closeness_centrality	19.3 k allocs: 14 MB	19.3 k allocs: 14 MB	1
centrality/graphs/degree_centrality	10 allocs: 5.43 kB	10 allocs: 5.43 kB	1
centrality/graphs/katz_centrality	2.96 k allocs: 3.1 MB	2.96 k allocs: 3.1 MB	1
connectivity/digraphs/strongly_connected_components	1.05 k allocs: 0.075 MB	1.05 k allocs: 0.075 MB	1
connectivity/graphs/connected_components	0.061 k allocs: 22.5 kB	0.061 k allocs: 22.5 kB	1
core/edges/digraphs	3 allocs: 0.0938 kB	3 allocs: 0.0938 kB	1
core/edges/graphs	3 allocs: 0.0938 kB	3 allocs: 0.0938 kB	1
core/has_edge/digraphs	20 allocs: 12.6 kB	20 allocs: 12.6 kB	1
core/has_edge/graphs	28 allocs: 13.8 kB	28 allocs: 13.8 kB	1
core/nv/digraphs	3 allocs: 0.0938 kB	3 allocs: 0.0938 kB	1
core/nv/graphs	3 allocs: 0.0938 kB	3 allocs: 0.0938 kB	1
edges/fille	3 allocs: 0.153 MB	3 allocs: 0.153 MB	1
edges/fillp	3 allocs: 0.153 MB	3 allocs: 0.153 MB	1
edges/tsume	0 allocs: 0 B	0 allocs: 0 B
edges/tsump	0 allocs: 0 B	0 allocs: 0 B
insertions/SG(n,e) Generation	0.0465 M allocs: 10.9 MB	0.0465 M allocs: 10.9 MB	0.999
parallel/egonet/twohop	10 allocs: 0.0768 MB	10 allocs: 0.0768 MB	1
parallel/egonet/vertexfunction	10 allocs: 0.0768 MB	10 allocs: 0.0768 MB	1
serial/egonet/twohop	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
serial/egonet/vertexfunction	3 allocs: 0.0764 MB	3 allocs: 0.0764 MB	1
traversals/digraphs/bfs_tree	2.34 k allocs: 0.113 MB	2.34 k allocs: 0.113 MB	1
traversals/digraphs/dfs_tree	2.44 k allocs: 0.118 MB	2.44 k allocs: 0.118 MB	1
traversals/graphs/bfs_tree	2.52 k allocs: 0.121 MB	2.52 k allocs: 0.121 MB	1
traversals/graphs/dfs_tree	2.63 k allocs: 0.127 MB	2.63 k allocs: 0.127 MB	1
time_to_load	0.145 k allocs: 11 kB	0.145 k allocs: 11 kB	1

[codecov]

Codecov Report

❌ Patch coverage is 0% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.14%. Comparing base (ca5cbc3) to head (884b277).

Files with missing lines	Patch %	Lines
src/igraphs_stubs.jl	0.00%	10 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #506      +/-   ##
==========================================
- Coverage   97.27%   97.14%   -0.13%     
==========================================
  Files         126      127       +1     
  Lines        7674     7684      +10     
==========================================
  Hits         7465     7465              
- Misses        209      219      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Krastanov]

We are currently discussing this in the IGraphs.jl repository. For now I will mark this as a draft, given that it is waiting on other PRs in IGraphs.jl. This makes it easier for me too keep my review queue a bit more organized. Lets convert it back to non-draft when the supporting PRs are done.