salesforce / TransmogrifAI

TransmogrifAI (pronounced trăns-mŏgˈrə-fī) is an AutoML library for building modular, reusable, strongly typed machine learning workflows on Apache Spark with minimal hand-tuning
https://transmogrif.ai
BSD 3-Clause "New" or "Revised" License
2.24k stars 392 forks source link

doc suggestions 1.0 #507

Closed rpanosSFDC closed 4 years ago

rpanosSFDC commented 4 years ago

Months ago when I installed TransmogrifAI, I took some notes on my struggles. These suggestions may help others.

codecov[bot] commented 4 years ago

Codecov Report

Merging #507 into master will decrease coverage by 30.73%. The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master     #507       +/-   ##
===========================================
- Coverage   86.70%   55.96%   -30.74%     
===========================================
  Files         347      345        -2     
  Lines       11830    11680      -150     
  Branches      382      378        -4     
===========================================
- Hits        10257     6537     -3720     
- Misses       1573     5143     +3570     
Impacted Files Coverage Δ
...in/scala/com/salesforce/op/testkit/RandomMap.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...n/scala/com/salesforce/op/readers/CSVReaders.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...scala/com/salesforce/op/utils/numeric/Number.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...scala/com/salesforce/op/utils/text/TextUtils.scala 0.00% <0.00%> (-100.00%) :arrow_down:
.../scala/com/salesforce/op/test/FeatureAsserts.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...cala/com/salesforce/op/utils/io/csv/CSVInOut.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...ala/com/salesforce/op/utils/tuples/RichTuple.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...ala/com/salesforce/op/readers/CSVAutoReaders.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...com/salesforce/op/test/TestOpWorkflowBuilder.scala 0.00% <0.00%> (-100.00%) :arrow_down:
...la/com/salesforce/op/test/TestFeatureBuilder.scala 0.00% <0.00%> (-100.00%) :arrow_down:
... and 204 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update f54a95f...43ed182. Read the comment docs.

rpanosSFDC commented 4 years ago

Sorry for the delay and thank you for letting me contribute!