Giter Site home page Giter Site logo

Comments (7)

ninamiolane avatar ninamiolane commented on May 21, 2024

The API Reference of TopoNetX displays the API of the functions:

Image

from topomodelx.

ninamiolane avatar ninamiolane commented on May 21, 2024

The API Reference of TopoModelX does not display the API of the functions:

Image

from topomodelx.

devendragovil avatar devendragovil commented on May 21, 2024

The issue hasn't been fixed completely, but API reference should be visible now.

from topomodelx.

ninamiolane avatar ninamiolane commented on May 21, 2024

@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.

ninamiolane avatar ninamiolane commented on May 21, 2024

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.

devendragovil avatar devendragovil commented on May 21, 2024

Yes, I would do that. @ninamiolane

from topomodelx.

ninamiolane avatar ninamiolane commented on May 21, 2024

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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.