Comments (17)
Would start maybe at weekends. Next 2 days have little bit more work to do. :)
from numsharp.
@Oceania2018 just one little thing. Sorry I mention it.
Shouldn't it be:
var a = np.arange(9).Reshape(3,3)?
So with capital R instead of small r?
The output of arange is a NDArray object. So we call its Reshape method.
What we are doing is method chaining. So we do not use the np.reshape method (if exist didn't look ^^') but the NDArray Reshape method.
from numsharp.
@Oceania2018 and question : shall we start doc with python sphinx? Or maybe take docfx? https://dotnet.github.io/docfx/
Just idk if sphinx can parse c# for api documentations by doc comments.
from numsharp.
We should use both of them, docfx is for generating md files, Sphinx is for organizing them, and make docs readable on readthedocs.io.
I prefer arange().reshape(), keep same as numpy as much as possible.
from numsharp.
@Oceania2018 at the moment I experiment with docfx - it does not look as bad as i though. Especially the API documentation and the style looks promising. Moreover docfx is the one which is used from Microsoft I though. The hosting we could do on Github Pages.
Just feel annoyed at sphinx python doc, that it highlight my C# code but it thinks it is python lol so the code looks not good. And was investigating for C# docs at moment.
How you think of docfx? i tried at https://dotchris90.github.io/NumSharp/ I will not merge it to Scisharp/NumSharp - so dont worry but I will see how well this can look like.
from numsharp.
Does docfx generate markdown file? I think docfx is used to generate developer's API reference, because it is generated from souce code directly. Sphinx is often used to make tutorial document, like quick start. Sphinx support markdown file, it's easy to use.
from numsharp.
Yes they are now able to do it. I was also surprised. Seems they developed quite well.
You can write so called articles which is equivalent sphinx tutorials. Using markdown. Very easy seems. So tutorials and api and swagger rest api and more seems (ok rest API is not important for us....).
I can maybe experiment with it and upload to my repo. If we think it looks good we can go with it. If not we take sphinx.
from numsharp.
@Oceania2018 an example for our api
https://dotchris90.github.io/NumSharp/api/NumSharp.NDArray-1.html
And example for article :
https://dotchris90.github.io/NumSharp/articles/NDArray.Creation.html
@Oceania2018 if u not too angry with me. I would like to go with docfx. They plan to support multiple languages besides c# in future and using 100% md for articles. Plus the generated docs folder can be hosted 100% on github for free.
The only thing that I am not satisfied is... The style. I look now for better template...
from numsharp.
@dotChris90 Docfx looks awesome. keep going.
from numsharp.
@Oceania2018 thanks. Before thinking about pull requests. Is NumSharps github page active? If not, could you activate it? Not sure if I can since u the founder / constructor of SciSharp organizations. :)
from numsharp.
@dotChris90 It's active. https://scisharp.github.io/NumSharp/
from numsharp.
@Oceania2018 thanks a lot. Then today maybe write some more user tutorials. ;)
And push.
from numsharp.
Sounds great. NumSharp got 80+ stars now. Seems like people really need it.
from numsharp.
Totally. Before c# was not the language of numeric. Since this year Microsoft push this AI and ML topics so hard... But Microsoft didn't give us a numerical stack.
But people deserve and need a numerical stack like NumSharp. :)
from numsharp.
Ok it worked. Just merged the docs which I already made. Nothing new. But will write some tutorials for user and also a small Readme how to use docfx best.
It's time we dotnet developers go deeper to science, machine learning and numerics.
from numsharp.
docfx is looking good.
from numsharp.
@henon @Oceania2018, Should we implement a documentation page like discussed here?
https://dotnet.github.io/docfx/
from numsharp.
Related Issues (20)
- np.random.choice with replace: false produces duplicates
- ToBitmap() - datatype mistmatch
- critical vulnerability in version 5.0.2 of system.drawing.common
- Numsharp array output in .net interactive notebooks is misleading
- Hello, has SciSharp/NumSharp stopped development and maintenance? HOT 2
- What is the exposed method for percentiles & median using np?
- Can NumSharp fit polynomial surface equations?
- np.linalg.pinv not supported HOT 1
- Is there an example on how to use it with IronPython?
- Possible typo "ToMuliDimArray()" HOT 1
- The fact that such an excellent project has many unimplemented APIs and is no longer being maintained is regrettable.
- Memory leak?
- `np.convolve` return null exception
- Cannot create an NDArray of shorts
- np.maximum error
- np.hstack has diffrent effect from python
- Extremely poor performance on sum reduce HOT 1
- How to save a nested dictionary with `save_npz`
- Does Numsharp work in Unity with the IL2CPP backend?
- how to change to Microsoft.ML.OnnxRuntime.Tensors.DenseTensor<float>?
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 numsharp.