Skip to content

Commit

Permalink
Deploy documentation (Pollen.jl)
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Aug 31, 2023
1 parent dd9d1a9 commit 783f011
Show file tree
Hide file tree
Showing 1,142 changed files with 84,981 additions and 8,975 deletions.
1 change: 1 addition & 0 deletions data/FluxTraining@pr-155/doc/CHANGELOG.md.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"attributes":{"backlinks":[],"path":"/home/runner/.julia/packages/FluxTraining/185if/CHANGELOG.md","title":"News"},"tag":"document","children":[{"attributes":{},"tag":"md","children":[{"attributes":{},"tag":"h1","children":["News"],"type":"node"},{"attributes":{},"tag":"h2","children":["Unreleased"],"type":"node"},{"attributes":{},"tag":"h3","children":["Added"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Support for ",{"attributes":{"href":"https://github.com/FluxML/Optimisers.jl","title":""},"tag":"a","children":["Optimisers.jl"],"type":"node"}," https://github.com/FluxML/FluxTraining.jl/pull/114."],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"h2","children":["[0.3.0] - 04.04.2022"],"type":"node"},{"attributes":{},"tag":"h3","children":["Added"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Short-hand ",{"attributes":{},"tag":"code","children":["Learner"],"type":"node"}," method ",{"attributes":{},"tag":"code","children":["Learner(model, lossfn[; data, optim, callbacks, kwargs...])"],"type":"node"},". The old method still exists but use is discouraged."],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Compatibility with Flux.jl v0.13 once released"],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{"href":"https://fluxml.ai/FluxTraining.jl/dev/i/?id=documents%2FREADME.md","title":""},"tag":"a","children":["Pollen.jl doucmentation frontend"],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"h3","children":["Changed"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["(BREAKING) Hyperparameter scheduling now uses ParameterSchedules.jl instead of Animations.jl for defining schedules. See ",{"attributes":{"href":"https://fluxml.ai/FluxTraining.jl/dev/documents/docs/tutorials/hyperparameters.md/","title":""},"tag":"a","children":["the docs"],"type":"node"},"."],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Fixes on documentation pages"],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"h2","children":["[0.2.0]"],"type":"node"},{"attributes":{},"tag":"h3","children":["Added"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["New training loop API that is easier to extend. Defining a ",{"attributes":{},"tag":"code","children":["Phase"],"type":"node"}," and ",{"attributes":{},"tag":"code","children":["step!"],"type":"node"}," is all you need. See ",{"attributes":{"href":"docs/tutorials/training.md","title":"","document_id":"FluxTraining@pr-155/doc/docs/tutorials/training.md"},"tag":"reference","children":["the new tutorial"],"type":"node"}," and ",{"attributes":{"href":"docs/reference/training.md","title":"","document_id":"FluxTraining@pr-155/doc/docs/reference/training.md"},"tag":"reference","children":["the new reference"],"type":"node"},"."],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Relevant functions: ",{"attributes":{"reftype":"symbol","href":"#","title":"","document_id":"FluxTraining@pr-155/ref/FluxTraining.epoch!"},"tag":"reference","children":[{"attributes":{},"tag":"code","children":["epoch!"],"type":"node"}],"type":"node"},", ",{"attributes":{"reftype":"symbol","href":"#","title":"","document_id":"FluxTraining@pr-155/ref/FluxTraining.step!"},"tag":"reference","children":[{"attributes":{},"tag":"code","children":["step!"],"type":"node"}],"type":"node"},", ",{"attributes":{"reftype":"symbol","href":"#","title":"","document_id":"FluxTraining@pr-155/ref/FluxTraining.runstep"},"tag":"reference","children":[{"attributes":{},"tag":"code","children":["runstep"],"type":"node"}],"type":"node"},", ",{"attributes":{"reftype":"symbol","href":"#","title":"","document_id":"FluxTraining@pr-155/ref/FluxTraining.runepoch"},"tag":"reference","children":[{"attributes":{},"tag":"code","children":["runepoch"],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Added ",{"attributes":{},"tag":"code","children":["CHANGELOG.md"],"type":"node"}," (this file)"],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{"href":"#","title":""},"tag":"a","children":[{"attributes":{},"tag":"code","children":["AbstractValidationPhase"],"type":"node"}],"type":"node"}," as supertype for validation phases"],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Documentation for callback helpers on ",{"attributes":{"href":"docs/callbacks/reference.md","title":"","document_id":"FluxTraining@pr-155/doc/docs/callbacks/reference.md"},"tag":"reference","children":["reference page"],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"h3","children":["Changed"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{},"tag":"code","children":["Batch*"],"type":"node"}," renamed to ",{"attributes":{},"tag":"code","children":["Step*"],"type":"node"},":"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["events: ",{"attributes":{},"tag":"code","children":["BatchBegin"],"type":"node"}," now ",{"attributes":{},"tag":"code","children":["StepBegin"],"type":"node"},", ",{"attributes":{},"tag":"code","children":["BatchEnd"],"type":"node"}," now ",{"attributes":{},"tag":"code","children":["StepEnd"],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{},"tag":"code","children":["CancelBatchException"],"type":"node"}," now ",{"attributes":{},"tag":"code","children":["CancelStepException"],"type":"node"},"."],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["field ",{"attributes":{},"tag":"code","children":["Learner.batch"],"type":"node"}," now ",{"attributes":{},"tag":"code","children":["Learner.step"],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{},"tag":"code","children":["Learner.step/batch"],"type":"node"}," is no longer a special ",{"attributes":{},"tag":"code","children":["struct"],"type":"node"}," but now a ",{"attributes":{},"tag":"code","children":["PropDict"],"type":"node"},", allowing you to set arbitrary fields."],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{},"tag":"code","children":["Learner.model"],"type":"node"}," can now be a ",{"attributes":{},"tag":"code","children":["NamedTuple/Tuple"],"type":"node"}," of models for use in custom training loops. Likewise, ",{"attributes":{},"tag":"code","children":["learner.params"],"type":"node"}," now resembles the structure of ",{"attributes":{},"tag":"code","children":["learner.model"],"type":"node"},", allowing separate access to parameters of different models."],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Callbacks"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Added ",{"attributes":{"reftype":"symbol","href":"#","title":"","document_id":"FluxTraining@pr-155/ref/FluxTraining.init!"},"tag":"reference","children":[{"attributes":{},"tag":"code","children":["init!"],"type":"node"}],"type":"node"}," method for callback initilization, replacing the ",{"attributes":{},"tag":"code","children":["Init"],"type":"node"}," event which required a ",{"attributes":{},"tag":"code","children":["Phase"],"type":"node"}," to implement."],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{"reftype":"symbol","href":"#","title":"","document_id":"FluxTraining@pr-155/ref/FluxTraining.Scheduler"},"tag":"reference","children":[{"attributes":{},"tag":"code","children":["Scheduler"],"type":"node"}],"type":"node"}," now has internal step counter and no longer relies on ",{"attributes":{},"tag":"code","children":["Recorder"],"type":"node"},"'s history. This makes it easier to replace the scheduler without needing to offset the new schedules."],"type":"node"}],"type":"node"},{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":[{"attributes":{"reftype":"symbol","href":"#","title":"","document_id":"FluxTraining@pr-155/ref/FluxTraining.EarlyStopping"},"tag":"reference","children":[{"attributes":{},"tag":"code","children":["EarlyStopping"],"type":"node"}],"type":"node"}," callback now uses criteria from ",{"attributes":{"href":"https://github.com/ablaom/EarlyStopping.jl","title":""},"tag":"a","children":["EarlyStopping.jl"],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"},{"attributes":{},"tag":"h3","children":["Removed"],"type":"node"},{"attributes":{},"tag":"ul","children":[{"attributes":{},"tag":"li","children":[{"attributes":{},"tag":"p","children":["Removed old training API. Methods ",{"attributes":{},"tag":"code","children":["fitbatch!"],"type":"node"},", ",{"attributes":{},"tag":"code","children":["fitbatchphase!"],"type":"node"},", ",{"attributes":{},"tag":"code","children":["fitepoch!"],"type":"node"},", ",{"attributes":{},"tag":"code","children":["fitepochphase!"],"type":"node"}," have all been removed."],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"}],"type":"node"}
1 change: 1 addition & 0 deletions data/FluxTraining@pr-155/doc/LICENSE.md.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"attributes":{"backlinks":[],"path":"/home/runner/.julia/packages/FluxTraining/185if/LICENSE.md","title":"LICENSE"},"tag":"document","children":[{"attributes":{},"tag":"md","children":[{"attributes":{},"tag":"p","children":["MIT License"],"type":"node"},{"attributes":{},"tag":"p","children":["Copyright (c) 2020 lorenzoh ",{"attributes":{"href":"mailto:[email protected]","title":"","document_id":"mailto:[email protected]"},"tag":"reference","children":["[email protected]"],"type":"node"}],"type":"node"},{"attributes":{},"tag":"p","children":["Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:"],"type":"node"},{"attributes":{},"tag":"p","children":["The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software."],"type":"node"},{"attributes":{},"tag":"p","children":["THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."],"type":"node"}],"type":"node"}],"type":"node"}
Loading

0 comments on commit 783f011

Please sign in to comment.