j143 / systemds

An opensource ML system for end-to-end data science lifecycle
Apache License 2.0
0 stars 1 forks source link

Automatic command testing in the documentation #34

Open j143 opened 3 years ago

j143 commented 3 years ago

For example:

https://github.com/istio/istio.io/blob/master/README.md#testing-document-content https://github.com/istio/istio/wiki/Istio-Test-Framework

Pay attention to page test!

image

Doc project ideas:

https://developers.google.com/season-of-docs/docs/project-ideas

j143 commented 3 years ago

https://github.com/AlexanderPrendota/kotlin-samples-verifier/blob/master/action/examples-workflow/verify-samples-on-push.yml

        uses: vmishenev/kotlin-samples-pusher@master
        with:
          io-event: '' #unset io-event
          push-repository: 'https://github.com/vmishenev/kotlin-compiler-server'
          snippet-flags: 'kotlin'
          push-path: 'src/test/resources/test-compile-data/kotlin-web-site'
          username: '${{ secrets.GITHUB_TOKEN }}' #token with an access to create PR in push-repository and issue in this repository
          start-commit: '${{ github.event.before }}'
          end-commit: '${{ github.event.after }}'
j143 commented 3 years ago

https://apache.github.io/systemds/site/builtins-reference.html#example-1

Tested 🆗

numClasses = 1
z = rand(rows = 5, cols = 1, min = 1, max = 9)
X = round(rand(rows = 5, cols = 1, min = 1, max = numClasses))
y = toOneHot(X, numClasses)
[ConfusionSum, ConfusionAvg] = confusionMatrix(P=z, Y=y)

Problems:

  1. The tests are already there for builtin functions in the integration suite.
  2. How is this different from integration suite tests.