Comments (7)
The API Reference of TopoNetX displays the API of the functions:
from topomodelx.
The API Reference of TopoModelX does not display the API of the functions:
from topomodelx.
The issue hasn't been fixed completely, but API reference should be visible now.
from topomodelx.
@devendragovil I'm re-opening this issue since it is not solved.
There seems to be only one neural layer on each domain that appears, e.g. only the TemplateLayer for Hypergraph. We need all of them to appear in the documentation.
This should be as easy as copy pasting the necessary lines of the form:
.. automodule:: topomodelx.nn.hypergraph.template_layer
:members:
into that file:
https://github.com/pyt-team/TopoModelX/blob/main/docs/api/nn.rst
from topomodelx.
Copy-pasting @ffl096 'comment:
We document everything on a single page, something no other popular package I know does. Every class should have its own page in the documentation. Then there wouldn't be any reference clashes and everything works fine. We don't have to reinvent anything here, look how NetworkX and others do it, e.g., https://networkx.org/documentation/stable/reference/algorithms/generated/networkx.algorithms.isomorphism.is_isomorphic.html
@devendragovil would it be possible to do this?
from topomodelx.
Yes, I would do that. @ninamiolane
from topomodelx.
Thank you so much @devendragovil .
I'm adding the high-priority label to this, because this task is blocking others.
from topomodelx.
Related Issues (20)
- Check docstrings everywhere HOT 5
- Make unique doc website for the three packages HOT 8
- RED LIST: Check before submitting
- Write coverletter
- Diagnose & Speed-up Hypergraph tutorials HOT 10
- `Dist2Cycle` never calls `Dist2CycleLayer`s HOT 5
- Extends TopoEmbedX to ColoredHypergraphs and Path complexes
- Possible bug in scatter_sum
- Best Practices for batching?
- Add path complex neural network in TopoModelX
- can_train tutorial fails with new sparse casting
- Review nn/hypergraph models HOT 1
- Review nn/simplicial models
- Review nn/cell and nn/combinatorial models HOT 1
- Fix bug in CAN tutorial
- Create Dataloaders HOT 1
- Add notebooks from TDL paper's experiments HOT 1
- Review and rewrite models that are not using topomodelx.base.conv primitives
- `SCConv` needs a full revision HOT 2
- Add `numpydoc` validation to CI
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from topomodelx.